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 *lower_inode
)
63 ecryptfs_set_inode_lower(inode
, (struct inode
*)lower_inode
);
64 inode
->i_ino
= ((struct inode
*)lower_inode
)->i_ino
;
66 inode
->i_op
= &ecryptfs_main_iops
;
67 inode
->i_fop
= &ecryptfs_main_fops
;
68 inode
->i_mapping
->a_ops
= &ecryptfs_aops
;
72 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
73 struct super_block
*sb
)
78 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
)) {
82 if (!igrab(lower_inode
)) {
86 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
87 ecryptfs_inode_test
, ecryptfs_inode_set
,
94 if (inode
->i_state
& I_NEW
)
95 unlock_new_inode(inode
);
98 if (S_ISLNK(lower_inode
->i_mode
))
99 inode
->i_op
= &ecryptfs_symlink_iops
;
100 else if (S_ISDIR(lower_inode
->i_mode
))
101 inode
->i_op
= &ecryptfs_dir_iops
;
102 if (S_ISDIR(lower_inode
->i_mode
))
103 inode
->i_fop
= &ecryptfs_dir_fops
;
104 if (special_file(lower_inode
->i_mode
))
105 init_special_inode(inode
, lower_inode
->i_mode
,
106 lower_inode
->i_rdev
);
107 fsstack_copy_attr_all(inode
, lower_inode
);
108 /* This size will be overwritten for real files w/ headers and
110 fsstack_copy_inode_size(inode
, lower_inode
);
116 #define ECRYPTFS_INTERPOSE_FLAG_D_ADD 0x00000001
119 * @lower_dentry: Existing dentry in the lower filesystem
120 * @dentry: ecryptfs' dentry
121 * @sb: ecryptfs's super_block
122 * @flags: flags to govern behavior of interpose procedure
124 * Interposes upper and lower dentries.
126 * Returns zero on success; non-zero otherwise
128 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
129 struct dentry
*dentry
, struct super_block
*sb
,
132 struct inode
*lower_inode
= lower_dentry
->d_inode
;
133 struct inode
*inode
= ecryptfs_get_inode(lower_inode
, sb
);
135 return PTR_ERR(inode
);
136 if (flags
& ECRYPTFS_INTERPOSE_FLAG_D_ADD
)
137 d_add(dentry
, inode
);
139 d_instantiate(dentry
, inode
);
144 * ecryptfs_create_underlying_file
145 * @lower_dir_inode: inode of the parent in the lower fs of the new file
146 * @dentry: New file's dentry
147 * @mode: The mode of the new file
148 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
150 * Creates the file in the lower file system.
152 * Returns zero on success; non-zero on error condition
155 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
156 struct dentry
*dentry
, int mode
,
157 struct nameidata
*nd
)
159 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
160 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
161 struct dentry
*dentry_save
;
162 struct vfsmount
*vfsmount_save
;
163 unsigned int flags_save
;
167 dentry_save
= nd
->path
.dentry
;
168 vfsmount_save
= nd
->path
.mnt
;
169 flags_save
= nd
->flags
;
170 nd
->path
.dentry
= lower_dentry
;
171 nd
->path
.mnt
= lower_mnt
;
172 nd
->flags
&= ~LOOKUP_OPEN
;
174 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
176 nd
->path
.dentry
= dentry_save
;
177 nd
->path
.mnt
= vfsmount_save
;
178 nd
->flags
= flags_save
;
185 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
186 * @ecryptfs_dentry: New file's dentry in ecryptfs
187 * @mode: The mode of the new file
188 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
190 * Creates the underlying file and the eCryptfs inode which will link to
191 * it. It will also update the eCryptfs directory inode to mimic the
192 * stat of the lower directory inode.
194 * Returns zero on success; non-zero on error condition
197 ecryptfs_do_create(struct inode
*directory_inode
,
198 struct dentry
*ecryptfs_dentry
, int mode
,
199 struct nameidata
*nd
)
202 struct dentry
*lower_dentry
;
203 struct dentry
*lower_dir_dentry
;
205 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
206 lower_dir_dentry
= lock_parent(lower_dentry
);
207 if (IS_ERR(lower_dir_dentry
)) {
208 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
210 rc
= PTR_ERR(lower_dir_dentry
);
213 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
214 ecryptfs_dentry
, mode
, nd
);
216 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
217 "rc = [%d]\n", __func__
, rc
);
220 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
221 directory_inode
->i_sb
, 0);
223 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
226 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
227 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
229 unlock_dir(lower_dir_dentry
);
235 * ecryptfs_initialize_file
237 * Cause the file to be changed from a basic empty file to an ecryptfs
238 * file with a header and first data page.
240 * Returns zero on success
242 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
244 struct ecryptfs_crypt_stat
*crypt_stat
=
245 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
248 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
249 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
250 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
253 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
254 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
256 ecryptfs_printk(KERN_ERR
, "Error creating new file "
257 "context; rc = [%d]\n", rc
);
260 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
);
262 printk(KERN_ERR
"%s: Error attempting to initialize "
263 "the lower file for the dentry with name "
264 "[%s]; rc = [%d]\n", __func__
,
265 ecryptfs_dentry
->d_name
.name
, rc
);
268 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
270 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
271 ecryptfs_put_lower_file(ecryptfs_dentry
->d_inode
);
278 * @dir: The inode of the directory in which to create the file.
279 * @dentry: The eCryptfs dentry
280 * @mode: The mode of the new file.
283 * Creates a new file.
285 * Returns zero on success; non-zero on error condition
288 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
289 int mode
, struct nameidata
*nd
)
293 /* ecryptfs_do_create() calls ecryptfs_interpose() */
294 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
296 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
297 "lower filesystem\n");
300 /* At this point, a file exists on "disk"; we need to make sure
301 * that this on disk file is prepared to be an ecryptfs file */
302 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
308 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
310 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
311 struct dentry
*lower_dentry
,
312 struct inode
*ecryptfs_dir_inode
)
314 struct dentry
*lower_dir_dentry
;
315 struct vfsmount
*lower_mnt
;
316 struct inode
*lower_inode
;
317 struct ecryptfs_crypt_stat
*crypt_stat
;
318 char *page_virt
= NULL
;
319 int put_lower
= 0, rc
= 0;
321 lower_dir_dentry
= lower_dentry
->d_parent
;
322 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
323 ecryptfs_dentry
->d_parent
));
324 lower_inode
= lower_dentry
->d_inode
;
325 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
326 BUG_ON(!lower_dentry
->d_count
);
327 ecryptfs_set_dentry_private(ecryptfs_dentry
,
328 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
330 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
332 printk(KERN_ERR
"%s: Out of memory whilst attempting "
333 "to allocate ecryptfs_dentry_info struct\n",
337 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
338 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
339 if (!lower_dentry
->d_inode
) {
340 /* We want to add because we couldn't find in lower */
341 d_add(ecryptfs_dentry
, NULL
);
344 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
345 ecryptfs_dir_inode
->i_sb
,
346 ECRYPTFS_INTERPOSE_FLAG_D_ADD
);
348 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
352 if (S_ISDIR(lower_inode
->i_mode
))
354 if (S_ISLNK(lower_inode
->i_mode
))
356 if (special_file(lower_inode
->i_mode
))
358 /* Released in this function */
359 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
361 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
366 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
);
368 printk(KERN_ERR
"%s: Error attempting to initialize "
369 "the lower file for the dentry with name "
370 "[%s]; rc = [%d]\n", __func__
,
371 ecryptfs_dentry
->d_name
.name
, rc
);
375 crypt_stat
= &ecryptfs_inode_to_private(
376 ecryptfs_dentry
->d_inode
)->crypt_stat
;
377 /* TODO: lock for crypt_stat comparison */
378 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
379 ecryptfs_set_default_sizes(crypt_stat
);
380 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
381 ecryptfs_dentry
->d_inode
);
383 memset(page_virt
, 0, PAGE_CACHE_SIZE
);
384 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
390 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
392 ecryptfs_i_size_init(page_virt
, ecryptfs_dentry
->d_inode
);
394 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
399 d_drop(ecryptfs_dentry
);
402 ecryptfs_put_lower_file(ecryptfs_dentry
->d_inode
);
408 * @ecryptfs_dir_inode: The eCryptfs directory inode
409 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
410 * @ecryptfs_nd: nameidata; may be NULL
412 * Find a file on disk. If the file does not exist, then we'll add it to the
413 * dentry cache and continue on to read it from the disk.
415 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
416 struct dentry
*ecryptfs_dentry
,
417 struct nameidata
*ecryptfs_nd
)
419 char *encrypted_and_encoded_name
= NULL
;
420 size_t encrypted_and_encoded_name_size
;
421 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
422 struct dentry
*lower_dir_dentry
, *lower_dentry
;
425 if ((ecryptfs_dentry
->d_name
.len
== 1
426 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
427 || (ecryptfs_dentry
->d_name
.len
== 2
428 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
431 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
432 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
433 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
435 ecryptfs_dentry
->d_name
.len
);
436 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
437 if (IS_ERR(lower_dentry
)) {
438 rc
= PTR_ERR(lower_dentry
);
439 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
440 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
441 encrypted_and_encoded_name
);
444 if (lower_dentry
->d_inode
)
445 goto lookup_and_interpose
;
446 mount_crypt_stat
= &ecryptfs_superblock_to_private(
447 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
448 if (!(mount_crypt_stat
449 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
450 goto lookup_and_interpose
;
452 rc
= ecryptfs_encrypt_and_encode_filename(
453 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
454 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
455 ecryptfs_dentry
->d_name
.len
);
457 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
458 "filename; rc = [%d]\n", __func__
, rc
);
461 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
462 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
464 encrypted_and_encoded_name_size
);
465 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
466 if (IS_ERR(lower_dentry
)) {
467 rc
= PTR_ERR(lower_dentry
);
468 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
469 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
470 encrypted_and_encoded_name
);
473 lookup_and_interpose
:
474 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
478 d_drop(ecryptfs_dentry
);
480 kfree(encrypted_and_encoded_name
);
484 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
485 struct dentry
*new_dentry
)
487 struct dentry
*lower_old_dentry
;
488 struct dentry
*lower_new_dentry
;
489 struct dentry
*lower_dir_dentry
;
493 file_size_save
= i_size_read(old_dentry
->d_inode
);
494 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
495 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
496 dget(lower_old_dentry
);
497 dget(lower_new_dentry
);
498 lower_dir_dentry
= lock_parent(lower_new_dentry
);
499 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
501 if (rc
|| !lower_new_dentry
->d_inode
)
503 rc
= ecryptfs_interpose(lower_new_dentry
, new_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
);
508 old_dentry
->d_inode
->i_nlink
=
509 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
510 i_size_write(new_dentry
->d_inode
, file_size_save
);
512 unlock_dir(lower_dir_dentry
);
513 dput(lower_new_dentry
);
514 dput(lower_old_dentry
);
518 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
521 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
522 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
523 struct dentry
*lower_dir_dentry
;
526 lower_dir_dentry
= lock_parent(lower_dentry
);
527 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
529 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
532 fsstack_copy_attr_times(dir
, lower_dir_inode
);
533 dentry
->d_inode
->i_nlink
=
534 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
535 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
538 unlock_dir(lower_dir_dentry
);
543 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
547 struct dentry
*lower_dentry
;
548 struct dentry
*lower_dir_dentry
;
549 char *encoded_symname
;
550 size_t encoded_symlen
;
551 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
553 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
555 lower_dir_dentry
= lock_parent(lower_dentry
);
556 mount_crypt_stat
= &ecryptfs_superblock_to_private(
557 dir
->i_sb
)->mount_crypt_stat
;
558 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
561 mount_crypt_stat
, symname
,
565 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
567 kfree(encoded_symname
);
568 if (rc
|| !lower_dentry
->d_inode
)
570 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
573 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
574 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
576 unlock_dir(lower_dir_dentry
);
578 if (!dentry
->d_inode
)
583 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
586 struct dentry
*lower_dentry
;
587 struct dentry
*lower_dir_dentry
;
589 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
590 lower_dir_dentry
= lock_parent(lower_dentry
);
591 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
592 if (rc
|| !lower_dentry
->d_inode
)
594 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
597 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
598 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
599 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
601 unlock_dir(lower_dir_dentry
);
602 if (!dentry
->d_inode
)
607 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
609 struct dentry
*lower_dentry
;
610 struct dentry
*lower_dir_dentry
;
613 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
615 lower_dir_dentry
= lock_parent(lower_dentry
);
617 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
619 if (!rc
&& dentry
->d_inode
)
620 clear_nlink(dentry
->d_inode
);
621 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
622 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
623 unlock_dir(lower_dir_dentry
);
631 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
634 struct dentry
*lower_dentry
;
635 struct dentry
*lower_dir_dentry
;
637 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
638 lower_dir_dentry
= lock_parent(lower_dentry
);
639 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
640 if (rc
|| !lower_dentry
->d_inode
)
642 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
645 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
646 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
648 unlock_dir(lower_dir_dentry
);
649 if (!dentry
->d_inode
)
655 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
656 struct inode
*new_dir
, struct dentry
*new_dentry
)
659 struct dentry
*lower_old_dentry
;
660 struct dentry
*lower_new_dentry
;
661 struct dentry
*lower_old_dir_dentry
;
662 struct dentry
*lower_new_dir_dentry
;
663 struct dentry
*trap
= NULL
;
665 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
666 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
667 dget(lower_old_dentry
);
668 dget(lower_new_dentry
);
669 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
670 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
671 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
672 /* source should not be ancestor of target */
673 if (trap
== lower_old_dentry
) {
677 /* target should not be ancestor of source */
678 if (trap
== lower_new_dentry
) {
682 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
683 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
686 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
687 if (new_dir
!= old_dir
)
688 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
690 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
691 dput(lower_new_dir_dentry
);
692 dput(lower_old_dir_dentry
);
693 dput(lower_new_dentry
);
694 dput(lower_old_dentry
);
698 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
701 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
703 size_t lower_bufsiz
= PATH_MAX
;
707 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
714 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
715 (char __user
*)lower_buf
,
721 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
722 lower_buf
, lower_bufsiz
);
729 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
732 size_t kbufsiz
, copied
;
735 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
738 copied
= min_t(size_t, bufsiz
, kbufsiz
);
739 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
741 fsstack_copy_attr_atime(dentry
->d_inode
,
742 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
747 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
750 int len
= PAGE_SIZE
, rc
;
753 /* Released in ecryptfs_put_link(); only release here on error */
754 buf
= kmalloc(len
, GFP_KERNEL
);
756 buf
= ERR_PTR(-ENOMEM
);
761 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
769 nd_set_link(nd
, buf
);
774 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
776 char *buf
= nd_get_link(nd
);
784 * upper_size_to_lower_size
785 * @crypt_stat: Crypt_stat associated with file
786 * @upper_size: Size of the upper file
788 * Calculate the required size of the lower file based on the
789 * specified size of the upper file. This calculation is based on the
790 * number of headers in the underlying file and the extent size.
792 * Returns Calculated size of the lower file.
795 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
800 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
801 if (upper_size
!= 0) {
804 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
805 if (upper_size
& ~crypt_stat
->extent_mask
)
807 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
814 * @dentry: The ecryptfs layer dentry
815 * @ia: Address of the ecryptfs inode's attributes
816 * @lower_ia: Address of the lower inode's attributes
818 * Function to handle truncations modifying the size of the file. Note
819 * that the file sizes are interpolated. When expanding, we are simply
820 * writing strings of 0's out. When truncating, we truncate the upper
821 * inode and update the lower_ia according to the page index
822 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
823 * the caller must use lower_ia in a call to notify_change() to perform
824 * the truncation of the lower inode.
826 * Returns zero on success; non-zero otherwise
828 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
829 struct iattr
*lower_ia
)
832 struct inode
*inode
= dentry
->d_inode
;
833 struct ecryptfs_crypt_stat
*crypt_stat
;
834 loff_t i_size
= i_size_read(inode
);
835 loff_t lower_size_before_truncate
;
836 loff_t lower_size_after_truncate
;
838 if (unlikely((ia
->ia_size
== i_size
))) {
839 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
842 rc
= ecryptfs_get_lower_file(dentry
);
845 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
846 /* Switch on growing or shrinking file */
847 if (ia
->ia_size
> i_size
) {
848 char zero
[] = { 0x00 };
850 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
851 /* Write a single 0 at the last position of the file;
852 * this triggers code that will fill in 0's throughout
853 * the intermediate portion of the previous end of the
854 * file and the new and of the file */
855 rc
= ecryptfs_write(inode
, zero
,
856 (ia
->ia_size
- 1), 1);
857 } else { /* ia->ia_size < i_size_read(inode) */
858 /* We're chopping off all the pages down to the page
859 * in which ia->ia_size is located. Fill in the end of
860 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
861 * PAGE_CACHE_SIZE with zeros. */
862 size_t num_zeros
= (PAGE_CACHE_SIZE
863 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
867 * XXX(truncate) this should really happen at the begginning
868 * of ->setattr. But the code is too messy to that as part
869 * of a larger patch. ecryptfs is also totally missing out
870 * on the inode_change_ok check at the beginning of
871 * ->setattr while would include this.
873 rc
= inode_newsize_ok(inode
, ia
->ia_size
);
877 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
878 truncate_setsize(inode
, ia
->ia_size
);
879 lower_ia
->ia_size
= ia
->ia_size
;
880 lower_ia
->ia_valid
|= ATTR_SIZE
;
886 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
891 rc
= ecryptfs_write(inode
, zeros_virt
,
892 ia
->ia_size
, num_zeros
);
895 printk(KERN_ERR
"Error attempting to zero out "
896 "the remainder of the end page on "
897 "reducing truncate; rc = [%d]\n", rc
);
901 truncate_setsize(inode
, ia
->ia_size
);
902 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
904 printk(KERN_ERR
"Problem with "
905 "ecryptfs_write_inode_size_to_metadata; "
909 /* We are reducing the size of the ecryptfs file, and need to
910 * know if we need to reduce the size of the lower file. */
911 lower_size_before_truncate
=
912 upper_size_to_lower_size(crypt_stat
, i_size
);
913 lower_size_after_truncate
=
914 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
915 if (lower_size_after_truncate
< lower_size_before_truncate
) {
916 lower_ia
->ia_size
= lower_size_after_truncate
;
917 lower_ia
->ia_valid
|= ATTR_SIZE
;
919 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
922 ecryptfs_put_lower_file(inode
);
928 * @dentry: The ecryptfs layer dentry
929 * @new_length: The length to expand the file to
931 * Simple function that handles the truncation of an eCryptfs inode and
932 * its corresponding lower inode.
934 * Returns zero on success; non-zero otherwise
936 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
938 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
939 struct iattr lower_ia
= { .ia_valid
= 0 };
942 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
943 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
944 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
946 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
947 rc
= notify_change(lower_dentry
, &lower_ia
);
948 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
954 ecryptfs_permission(struct inode
*inode
, int mask
, unsigned int flags
)
956 if (flags
& IPERM_FLAG_RCU
)
958 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
963 * @dentry: dentry handle to the inode to modify
964 * @ia: Structure with flags of what to change and values
966 * Updates the metadata of an inode. If the update is to the size
967 * i.e. truncation, then ecryptfs_truncate will handle the size modification
968 * of both the ecryptfs inode and the lower inode.
970 * All other metadata changes will be passed right to the lower filesystem,
971 * and we will just update our inode to look like the lower.
973 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
976 struct dentry
*lower_dentry
;
977 struct iattr lower_ia
;
979 struct inode
*lower_inode
;
980 struct ecryptfs_crypt_stat
*crypt_stat
;
982 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
983 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
984 ecryptfs_init_crypt_stat(crypt_stat
);
985 inode
= dentry
->d_inode
;
986 lower_inode
= ecryptfs_inode_to_lower(inode
);
987 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
988 mutex_lock(&crypt_stat
->cs_mutex
);
989 if (S_ISDIR(dentry
->d_inode
->i_mode
))
990 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
991 else if (S_ISREG(dentry
->d_inode
->i_mode
)
992 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
993 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
994 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
996 mount_crypt_stat
= &ecryptfs_superblock_to_private(
997 dentry
->d_sb
)->mount_crypt_stat
;
998 rc
= ecryptfs_get_lower_file(dentry
);
1000 mutex_unlock(&crypt_stat
->cs_mutex
);
1003 rc
= ecryptfs_read_metadata(dentry
);
1004 ecryptfs_put_lower_file(inode
);
1006 if (!(mount_crypt_stat
->flags
1007 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
1009 printk(KERN_WARNING
"Either the lower file "
1010 "is not in a valid eCryptfs format, "
1011 "or the key could not be retrieved. "
1012 "Plaintext passthrough mode is not "
1013 "enabled; returning -EIO\n");
1014 mutex_unlock(&crypt_stat
->cs_mutex
);
1018 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
1019 | ECRYPTFS_ENCRYPTED
);
1022 mutex_unlock(&crypt_stat
->cs_mutex
);
1023 if (S_ISREG(inode
->i_mode
)) {
1024 rc
= filemap_write_and_wait(inode
->i_mapping
);
1027 fsstack_copy_attr_all(inode
, lower_inode
);
1029 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
1030 if (ia
->ia_valid
& ATTR_FILE
)
1031 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
1032 if (ia
->ia_valid
& ATTR_SIZE
) {
1033 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
1039 * mode change is for clearing setuid/setgid bits. Allow lower fs
1040 * to interpret this in its own way.
1042 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
1043 lower_ia
.ia_valid
&= ~ATTR_MODE
;
1045 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1046 rc
= notify_change(lower_dentry
, &lower_ia
);
1047 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1049 fsstack_copy_attr_all(inode
, lower_inode
);
1053 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
1056 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1059 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1060 dentry
->d_sb
)->mount_crypt_stat
;
1061 generic_fillattr(dentry
->d_inode
, stat
);
1062 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1066 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
1069 stat
->size
= targetsiz
;
1075 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1078 struct kstat lower_stat
;
1081 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
1082 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
1084 fsstack_copy_attr_all(dentry
->d_inode
,
1085 ecryptfs_inode_to_lower(dentry
->d_inode
));
1086 generic_fillattr(dentry
->d_inode
, stat
);
1087 stat
->blocks
= lower_stat
.blocks
;
1093 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1094 size_t size
, int flags
)
1097 struct dentry
*lower_dentry
;
1099 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1100 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1105 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1111 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1112 void *value
, size_t size
)
1116 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1120 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1121 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1123 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1129 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1132 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1137 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1140 struct dentry
*lower_dentry
;
1142 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1143 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1147 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1148 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1149 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1154 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1157 struct dentry
*lower_dentry
;
1159 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1160 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1164 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1165 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1166 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1171 const struct inode_operations ecryptfs_symlink_iops
= {
1172 .readlink
= ecryptfs_readlink
,
1173 .follow_link
= ecryptfs_follow_link
,
1174 .put_link
= ecryptfs_put_link
,
1175 .permission
= ecryptfs_permission
,
1176 .setattr
= ecryptfs_setattr
,
1177 .getattr
= ecryptfs_getattr_link
,
1178 .setxattr
= ecryptfs_setxattr
,
1179 .getxattr
= ecryptfs_getxattr
,
1180 .listxattr
= ecryptfs_listxattr
,
1181 .removexattr
= ecryptfs_removexattr
1184 const struct inode_operations ecryptfs_dir_iops
= {
1185 .create
= ecryptfs_create
,
1186 .lookup
= ecryptfs_lookup
,
1187 .link
= ecryptfs_link
,
1188 .unlink
= ecryptfs_unlink
,
1189 .symlink
= ecryptfs_symlink
,
1190 .mkdir
= ecryptfs_mkdir
,
1191 .rmdir
= ecryptfs_rmdir
,
1192 .mknod
= ecryptfs_mknod
,
1193 .rename
= ecryptfs_rename
,
1194 .permission
= ecryptfs_permission
,
1195 .setattr
= ecryptfs_setattr
,
1196 .setxattr
= ecryptfs_setxattr
,
1197 .getxattr
= ecryptfs_getxattr
,
1198 .listxattr
= ecryptfs_listxattr
,
1199 .removexattr
= ecryptfs_removexattr
1202 const struct inode_operations ecryptfs_main_iops
= {
1203 .permission
= ecryptfs_permission
,
1204 .setattr
= ecryptfs_setattr
,
1205 .getattr
= ecryptfs_getattr
,
1206 .setxattr
= ecryptfs_setxattr
,
1207 .getxattr
= ecryptfs_getxattr
,
1208 .listxattr
= ecryptfs_listxattr
,
1209 .removexattr
= ecryptfs_removexattr