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(&(d_inode(dir
)->i_mutex
), I_MUTEX_PARENT
);
48 static void unlock_dir(struct dentry
*dir
)
50 mutex_unlock(&d_inode(dir
)->i_mutex
);
54 static int ecryptfs_inode_test(struct inode
*inode
, void *lower_inode
)
56 return ecryptfs_inode_to_lower(inode
) == lower_inode
;
59 static int ecryptfs_inode_set(struct inode
*inode
, void *opaque
)
61 struct inode
*lower_inode
= opaque
;
63 ecryptfs_set_inode_lower(inode
, lower_inode
);
64 fsstack_copy_attr_all(inode
, lower_inode
);
65 /* i_size will be overwritten for encrypted regular files */
66 fsstack_copy_inode_size(inode
, lower_inode
);
67 inode
->i_ino
= lower_inode
->i_ino
;
69 inode
->i_mapping
->a_ops
= &ecryptfs_aops
;
71 if (S_ISLNK(inode
->i_mode
))
72 inode
->i_op
= &ecryptfs_symlink_iops
;
73 else if (S_ISDIR(inode
->i_mode
))
74 inode
->i_op
= &ecryptfs_dir_iops
;
76 inode
->i_op
= &ecryptfs_main_iops
;
78 if (S_ISDIR(inode
->i_mode
))
79 inode
->i_fop
= &ecryptfs_dir_fops
;
80 else if (special_file(inode
->i_mode
))
81 init_special_inode(inode
, inode
->i_mode
, inode
->i_rdev
);
83 inode
->i_fop
= &ecryptfs_main_fops
;
88 static struct inode
*__ecryptfs_get_inode(struct inode
*lower_inode
,
89 struct super_block
*sb
)
93 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
))
94 return ERR_PTR(-EXDEV
);
95 if (!igrab(lower_inode
))
96 return ERR_PTR(-ESTALE
);
97 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
98 ecryptfs_inode_test
, ecryptfs_inode_set
,
102 return ERR_PTR(-EACCES
);
104 if (!(inode
->i_state
& I_NEW
))
110 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
111 struct super_block
*sb
)
113 struct inode
*inode
= __ecryptfs_get_inode(lower_inode
, sb
);
115 if (!IS_ERR(inode
) && (inode
->i_state
& I_NEW
))
116 unlock_new_inode(inode
);
123 * @lower_dentry: Existing dentry in the lower filesystem
124 * @dentry: ecryptfs' dentry
125 * @sb: ecryptfs's super_block
127 * Interposes upper and lower dentries.
129 * Returns zero on success; non-zero otherwise
131 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
132 struct dentry
*dentry
, struct super_block
*sb
)
134 struct inode
*inode
= ecryptfs_get_inode(d_inode(lower_dentry
), sb
);
137 return PTR_ERR(inode
);
138 d_instantiate(dentry
, inode
);
143 static int ecryptfs_do_unlink(struct inode
*dir
, struct dentry
*dentry
,
146 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
147 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
148 struct dentry
*lower_dir_dentry
;
152 lower_dir_dentry
= lock_parent(lower_dentry
);
153 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
, NULL
);
155 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
158 fsstack_copy_attr_times(dir
, lower_dir_inode
);
159 set_nlink(inode
, ecryptfs_inode_to_lower(inode
)->i_nlink
);
160 inode
->i_ctime
= dir
->i_ctime
;
163 unlock_dir(lower_dir_dentry
);
170 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
171 * @ecryptfs_dentry: New file's dentry in ecryptfs
172 * @mode: The mode of the new file
174 * Creates the underlying file and the eCryptfs inode which will link to
175 * it. It will also update the eCryptfs directory inode to mimic the
176 * stat of the lower directory inode.
178 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
180 static struct inode
*
181 ecryptfs_do_create(struct inode
*directory_inode
,
182 struct dentry
*ecryptfs_dentry
, umode_t mode
)
185 struct dentry
*lower_dentry
;
186 struct dentry
*lower_dir_dentry
;
189 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
190 lower_dir_dentry
= lock_parent(lower_dentry
);
191 rc
= vfs_create(d_inode(lower_dir_dentry
), lower_dentry
, mode
, true);
193 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
194 "rc = [%d]\n", __func__
, rc
);
198 inode
= __ecryptfs_get_inode(d_inode(lower_dentry
),
199 directory_inode
->i_sb
);
201 vfs_unlink(d_inode(lower_dir_dentry
), lower_dentry
, NULL
);
204 fsstack_copy_attr_times(directory_inode
, d_inode(lower_dir_dentry
));
205 fsstack_copy_inode_size(directory_inode
, d_inode(lower_dir_dentry
));
207 unlock_dir(lower_dir_dentry
);
212 * ecryptfs_initialize_file
214 * Cause the file to be changed from a basic empty file to an ecryptfs
215 * file with a header and first data page.
217 * Returns zero on success
219 int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
,
220 struct inode
*ecryptfs_inode
)
222 struct ecryptfs_crypt_stat
*crypt_stat
=
223 &ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
;
226 if (S_ISDIR(ecryptfs_inode
->i_mode
)) {
227 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
228 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
231 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
232 rc
= ecryptfs_new_file_context(ecryptfs_inode
);
234 ecryptfs_printk(KERN_ERR
, "Error creating new file "
235 "context; rc = [%d]\n", rc
);
238 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
, ecryptfs_inode
);
240 printk(KERN_ERR
"%s: Error attempting to initialize "
241 "the lower file for the dentry with name "
242 "[%pd]; rc = [%d]\n", __func__
,
243 ecryptfs_dentry
, rc
);
246 rc
= ecryptfs_write_metadata(ecryptfs_dentry
, ecryptfs_inode
);
248 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
249 ecryptfs_put_lower_file(ecryptfs_inode
);
256 * @dir: The inode of the directory in which to create the file.
257 * @dentry: The eCryptfs dentry
258 * @mode: The mode of the new file.
260 * Creates a new file.
262 * Returns zero on success; non-zero on error condition
265 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
266 umode_t mode
, bool excl
)
268 struct inode
*ecryptfs_inode
;
271 ecryptfs_inode
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
,
273 if (unlikely(IS_ERR(ecryptfs_inode
))) {
274 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
275 "lower filesystem\n");
276 rc
= PTR_ERR(ecryptfs_inode
);
279 /* At this point, a file exists on "disk"; we need to make sure
280 * that this on disk file is prepared to be an ecryptfs file */
281 rc
= ecryptfs_initialize_file(ecryptfs_dentry
, ecryptfs_inode
);
283 ecryptfs_do_unlink(directory_inode
, ecryptfs_dentry
,
285 make_bad_inode(ecryptfs_inode
);
286 unlock_new_inode(ecryptfs_inode
);
287 iput(ecryptfs_inode
);
290 unlock_new_inode(ecryptfs_inode
);
291 d_instantiate(ecryptfs_dentry
, ecryptfs_inode
);
296 static int ecryptfs_i_size_read(struct dentry
*dentry
, struct inode
*inode
)
298 struct ecryptfs_crypt_stat
*crypt_stat
;
301 rc
= ecryptfs_get_lower_file(dentry
, inode
);
303 printk(KERN_ERR
"%s: Error attempting to initialize "
304 "the lower file for the dentry with name "
305 "[%pd]; rc = [%d]\n", __func__
,
310 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
311 /* TODO: lock for crypt_stat comparison */
312 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
313 ecryptfs_set_default_sizes(crypt_stat
);
315 rc
= ecryptfs_read_and_validate_header_region(inode
);
316 ecryptfs_put_lower_file(inode
);
318 rc
= ecryptfs_read_and_validate_xattr_region(dentry
, inode
);
320 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
323 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
328 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
330 static int ecryptfs_lookup_interpose(struct dentry
*dentry
,
331 struct dentry
*lower_dentry
,
332 struct inode
*dir_inode
)
334 struct inode
*inode
, *lower_inode
= d_inode(lower_dentry
);
335 struct ecryptfs_dentry_info
*dentry_info
;
336 struct vfsmount
*lower_mnt
;
339 dentry_info
= kmem_cache_alloc(ecryptfs_dentry_info_cache
, GFP_KERNEL
);
341 printk(KERN_ERR
"%s: Out of memory whilst attempting "
342 "to allocate ecryptfs_dentry_info struct\n",
348 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(dentry
->d_parent
));
349 fsstack_copy_attr_atime(dir_inode
, d_inode(lower_dentry
->d_parent
));
350 BUG_ON(!d_count(lower_dentry
));
352 ecryptfs_set_dentry_private(dentry
, dentry_info
);
353 dentry_info
->lower_path
.mnt
= lower_mnt
;
354 dentry_info
->lower_path
.dentry
= lower_dentry
;
356 if (d_really_is_negative(lower_dentry
)) {
357 /* We want to add because we couldn't find in lower */
361 inode
= __ecryptfs_get_inode(lower_inode
, dir_inode
->i_sb
);
363 printk(KERN_ERR
"%s: Error interposing; rc = [%ld]\n",
364 __func__
, PTR_ERR(inode
));
365 return PTR_ERR(inode
);
367 if (S_ISREG(inode
->i_mode
)) {
368 rc
= ecryptfs_i_size_read(dentry
, inode
);
370 make_bad_inode(inode
);
375 if (inode
->i_state
& I_NEW
)
376 unlock_new_inode(inode
);
377 d_add(dentry
, inode
);
384 * @ecryptfs_dir_inode: The eCryptfs directory inode
385 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
386 * @flags: lookup flags
388 * Find a file on disk. If the file does not exist, then we'll add it to the
389 * dentry cache and continue on to read it from the disk.
391 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
392 struct dentry
*ecryptfs_dentry
,
395 char *encrypted_and_encoded_name
= NULL
;
396 size_t encrypted_and_encoded_name_size
;
397 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
398 struct dentry
*lower_dir_dentry
, *lower_dentry
;
401 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
402 mutex_lock(&d_inode(lower_dir_dentry
)->i_mutex
);
403 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
405 ecryptfs_dentry
->d_name
.len
);
406 mutex_unlock(&d_inode(lower_dir_dentry
)->i_mutex
);
407 if (IS_ERR(lower_dentry
)) {
408 rc
= PTR_ERR(lower_dentry
);
409 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
410 "[%d] on lower_dentry = [%pd]\n", __func__
, rc
,
414 if (d_really_is_positive(lower_dentry
))
416 mount_crypt_stat
= &ecryptfs_superblock_to_private(
417 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
418 if (!(mount_crypt_stat
419 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
422 rc
= ecryptfs_encrypt_and_encode_filename(
423 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
424 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
425 ecryptfs_dentry
->d_name
.len
);
427 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
428 "filename; rc = [%d]\n", __func__
, rc
);
431 mutex_lock(&d_inode(lower_dir_dentry
)->i_mutex
);
432 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
434 encrypted_and_encoded_name_size
);
435 mutex_unlock(&d_inode(lower_dir_dentry
)->i_mutex
);
436 if (IS_ERR(lower_dentry
)) {
437 rc
= PTR_ERR(lower_dentry
);
438 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
439 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
440 encrypted_and_encoded_name
);
444 rc
= ecryptfs_lookup_interpose(ecryptfs_dentry
, lower_dentry
,
447 kfree(encrypted_and_encoded_name
);
451 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
452 struct dentry
*new_dentry
)
454 struct dentry
*lower_old_dentry
;
455 struct dentry
*lower_new_dentry
;
456 struct dentry
*lower_dir_dentry
;
460 file_size_save
= i_size_read(d_inode(old_dentry
));
461 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
462 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
463 dget(lower_old_dentry
);
464 dget(lower_new_dentry
);
465 lower_dir_dentry
= lock_parent(lower_new_dentry
);
466 rc
= vfs_link(lower_old_dentry
, d_inode(lower_dir_dentry
),
467 lower_new_dentry
, NULL
);
468 if (rc
|| d_really_is_negative(lower_new_dentry
))
470 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
);
473 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
474 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
475 set_nlink(d_inode(old_dentry
),
476 ecryptfs_inode_to_lower(d_inode(old_dentry
))->i_nlink
);
477 i_size_write(d_inode(new_dentry
), file_size_save
);
479 unlock_dir(lower_dir_dentry
);
480 dput(lower_new_dentry
);
481 dput(lower_old_dentry
);
485 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
487 return ecryptfs_do_unlink(dir
, dentry
, d_inode(dentry
));
490 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
494 struct dentry
*lower_dentry
;
495 struct dentry
*lower_dir_dentry
;
496 char *encoded_symname
;
497 size_t encoded_symlen
;
498 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
500 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
502 lower_dir_dentry
= lock_parent(lower_dentry
);
503 mount_crypt_stat
= &ecryptfs_superblock_to_private(
504 dir
->i_sb
)->mount_crypt_stat
;
505 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
508 mount_crypt_stat
, symname
,
512 rc
= vfs_symlink(d_inode(lower_dir_dentry
), lower_dentry
,
514 kfree(encoded_symname
);
515 if (rc
|| d_really_is_negative(lower_dentry
))
517 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
520 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
521 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
523 unlock_dir(lower_dir_dentry
);
525 if (d_really_is_negative(dentry
))
530 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
533 struct dentry
*lower_dentry
;
534 struct dentry
*lower_dir_dentry
;
536 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
537 lower_dir_dentry
= lock_parent(lower_dentry
);
538 rc
= vfs_mkdir(d_inode(lower_dir_dentry
), lower_dentry
, mode
);
539 if (rc
|| d_really_is_negative(lower_dentry
))
541 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
544 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
545 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
546 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
548 unlock_dir(lower_dir_dentry
);
549 if (d_really_is_negative(dentry
))
554 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
556 struct dentry
*lower_dentry
;
557 struct dentry
*lower_dir_dentry
;
560 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
562 lower_dir_dentry
= lock_parent(lower_dentry
);
564 rc
= vfs_rmdir(d_inode(lower_dir_dentry
), lower_dentry
);
566 if (!rc
&& d_really_is_positive(dentry
))
567 clear_nlink(d_inode(dentry
));
568 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
569 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
570 unlock_dir(lower_dir_dentry
);
578 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
, dev_t dev
)
581 struct dentry
*lower_dentry
;
582 struct dentry
*lower_dir_dentry
;
584 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
585 lower_dir_dentry
= lock_parent(lower_dentry
);
586 rc
= vfs_mknod(d_inode(lower_dir_dentry
), lower_dentry
, mode
, dev
);
587 if (rc
|| d_really_is_negative(lower_dentry
))
589 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
592 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
593 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
595 unlock_dir(lower_dir_dentry
);
596 if (d_really_is_negative(dentry
))
602 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
603 struct inode
*new_dir
, struct dentry
*new_dentry
)
606 struct dentry
*lower_old_dentry
;
607 struct dentry
*lower_new_dentry
;
608 struct dentry
*lower_old_dir_dentry
;
609 struct dentry
*lower_new_dir_dentry
;
610 struct dentry
*trap
= NULL
;
611 struct inode
*target_inode
;
613 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
614 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
615 dget(lower_old_dentry
);
616 dget(lower_new_dentry
);
617 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
618 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
619 target_inode
= d_inode(new_dentry
);
620 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
621 /* source should not be ancestor of target */
622 if (trap
== lower_old_dentry
) {
626 /* target should not be ancestor of source */
627 if (trap
== lower_new_dentry
) {
631 rc
= vfs_rename(d_inode(lower_old_dir_dentry
), lower_old_dentry
,
632 d_inode(lower_new_dir_dentry
), lower_new_dentry
,
637 fsstack_copy_attr_all(target_inode
,
638 ecryptfs_inode_to_lower(target_inode
));
639 fsstack_copy_attr_all(new_dir
, d_inode(lower_new_dir_dentry
));
640 if (new_dir
!= old_dir
)
641 fsstack_copy_attr_all(old_dir
, d_inode(lower_old_dir_dentry
));
643 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
644 dput(lower_new_dir_dentry
);
645 dput(lower_old_dir_dentry
);
646 dput(lower_new_dentry
);
647 dput(lower_old_dentry
);
651 static char *ecryptfs_readlink_lower(struct dentry
*dentry
, size_t *bufsiz
)
653 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
659 lower_buf
= kmalloc(PATH_MAX
, GFP_KERNEL
);
661 return ERR_PTR(-ENOMEM
);
664 rc
= d_inode(lower_dentry
)->i_op
->readlink(lower_dentry
,
665 (char __user
*)lower_buf
,
670 rc
= ecryptfs_decode_and_decrypt_filename(&buf
, bufsiz
, dentry
->d_sb
,
674 return rc
? ERR_PTR(rc
) : buf
;
677 static const char *ecryptfs_follow_link(struct dentry
*dentry
, void **cookie
)
680 char *buf
= ecryptfs_readlink_lower(dentry
, &len
);
683 fsstack_copy_attr_atime(d_inode(dentry
),
684 d_inode(ecryptfs_dentry_to_lower(dentry
)));
686 return *cookie
= buf
;
690 * upper_size_to_lower_size
691 * @crypt_stat: Crypt_stat associated with file
692 * @upper_size: Size of the upper file
694 * Calculate the required size of the lower file based on the
695 * specified size of the upper file. This calculation is based on the
696 * number of headers in the underlying file and the extent size.
698 * Returns Calculated size of the lower file.
701 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
706 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
707 if (upper_size
!= 0) {
710 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
711 if (upper_size
& ~crypt_stat
->extent_mask
)
713 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
720 * @dentry: The ecryptfs layer dentry
721 * @ia: Address of the ecryptfs inode's attributes
722 * @lower_ia: Address of the lower inode's attributes
724 * Function to handle truncations modifying the size of the file. Note
725 * that the file sizes are interpolated. When expanding, we are simply
726 * writing strings of 0's out. When truncating, we truncate the upper
727 * inode and update the lower_ia according to the page index
728 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
729 * the caller must use lower_ia in a call to notify_change() to perform
730 * the truncation of the lower inode.
732 * Returns zero on success; non-zero otherwise
734 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
735 struct iattr
*lower_ia
)
738 struct inode
*inode
= d_inode(dentry
);
739 struct ecryptfs_crypt_stat
*crypt_stat
;
740 loff_t i_size
= i_size_read(inode
);
741 loff_t lower_size_before_truncate
;
742 loff_t lower_size_after_truncate
;
744 if (unlikely((ia
->ia_size
== i_size
))) {
745 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
748 rc
= ecryptfs_get_lower_file(dentry
, inode
);
751 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
752 /* Switch on growing or shrinking file */
753 if (ia
->ia_size
> i_size
) {
754 char zero
[] = { 0x00 };
756 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
757 /* Write a single 0 at the last position of the file;
758 * this triggers code that will fill in 0's throughout
759 * the intermediate portion of the previous end of the
760 * file and the new and of the file */
761 rc
= ecryptfs_write(inode
, zero
,
762 (ia
->ia_size
- 1), 1);
763 } else { /* ia->ia_size < i_size_read(inode) */
764 /* We're chopping off all the pages down to the page
765 * in which ia->ia_size is located. Fill in the end of
766 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
767 * PAGE_CACHE_SIZE with zeros. */
768 size_t num_zeros
= (PAGE_CACHE_SIZE
769 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
771 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
772 truncate_setsize(inode
, ia
->ia_size
);
773 lower_ia
->ia_size
= ia
->ia_size
;
774 lower_ia
->ia_valid
|= ATTR_SIZE
;
780 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
785 rc
= ecryptfs_write(inode
, zeros_virt
,
786 ia
->ia_size
, num_zeros
);
789 printk(KERN_ERR
"Error attempting to zero out "
790 "the remainder of the end page on "
791 "reducing truncate; rc = [%d]\n", rc
);
795 truncate_setsize(inode
, ia
->ia_size
);
796 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
798 printk(KERN_ERR
"Problem with "
799 "ecryptfs_write_inode_size_to_metadata; "
803 /* We are reducing the size of the ecryptfs file, and need to
804 * know if we need to reduce the size of the lower file. */
805 lower_size_before_truncate
=
806 upper_size_to_lower_size(crypt_stat
, i_size
);
807 lower_size_after_truncate
=
808 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
809 if (lower_size_after_truncate
< lower_size_before_truncate
) {
810 lower_ia
->ia_size
= lower_size_after_truncate
;
811 lower_ia
->ia_valid
|= ATTR_SIZE
;
813 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
816 ecryptfs_put_lower_file(inode
);
820 static int ecryptfs_inode_newsize_ok(struct inode
*inode
, loff_t offset
)
822 struct ecryptfs_crypt_stat
*crypt_stat
;
823 loff_t lower_oldsize
, lower_newsize
;
825 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
826 lower_oldsize
= upper_size_to_lower_size(crypt_stat
,
828 lower_newsize
= upper_size_to_lower_size(crypt_stat
, offset
);
829 if (lower_newsize
> lower_oldsize
) {
831 * The eCryptfs inode and the new *lower* size are mixed here
832 * because we may not have the lower i_mutex held and/or it may
833 * not be appropriate to call inode_newsize_ok() with inodes
834 * from other filesystems.
836 return inode_newsize_ok(inode
, lower_newsize
);
844 * @dentry: The ecryptfs layer dentry
845 * @new_length: The length to expand the file to
847 * Simple function that handles the truncation of an eCryptfs inode and
848 * its corresponding lower inode.
850 * Returns zero on success; non-zero otherwise
852 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
854 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
855 struct iattr lower_ia
= { .ia_valid
= 0 };
858 rc
= ecryptfs_inode_newsize_ok(d_inode(dentry
), new_length
);
862 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
863 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
864 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
866 mutex_lock(&d_inode(lower_dentry
)->i_mutex
);
867 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
868 mutex_unlock(&d_inode(lower_dentry
)->i_mutex
);
874 ecryptfs_permission(struct inode
*inode
, int mask
)
876 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
881 * @dentry: dentry handle to the inode to modify
882 * @ia: Structure with flags of what to change and values
884 * Updates the metadata of an inode. If the update is to the size
885 * i.e. truncation, then ecryptfs_truncate will handle the size modification
886 * of both the ecryptfs inode and the lower inode.
888 * All other metadata changes will be passed right to the lower filesystem,
889 * and we will just update our inode to look like the lower.
891 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
894 struct dentry
*lower_dentry
;
895 struct iattr lower_ia
;
897 struct inode
*lower_inode
;
898 struct ecryptfs_crypt_stat
*crypt_stat
;
900 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
901 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
902 ecryptfs_init_crypt_stat(crypt_stat
);
903 inode
= d_inode(dentry
);
904 lower_inode
= ecryptfs_inode_to_lower(inode
);
905 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
906 mutex_lock(&crypt_stat
->cs_mutex
);
907 if (d_is_dir(dentry
))
908 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
909 else if (d_is_reg(dentry
)
910 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
911 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
912 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
914 mount_crypt_stat
= &ecryptfs_superblock_to_private(
915 dentry
->d_sb
)->mount_crypt_stat
;
916 rc
= ecryptfs_get_lower_file(dentry
, inode
);
918 mutex_unlock(&crypt_stat
->cs_mutex
);
921 rc
= ecryptfs_read_metadata(dentry
);
922 ecryptfs_put_lower_file(inode
);
924 if (!(mount_crypt_stat
->flags
925 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
927 printk(KERN_WARNING
"Either the lower file "
928 "is not in a valid eCryptfs format, "
929 "or the key could not be retrieved. "
930 "Plaintext passthrough mode is not "
931 "enabled; returning -EIO\n");
932 mutex_unlock(&crypt_stat
->cs_mutex
);
936 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
937 | ECRYPTFS_ENCRYPTED
);
940 mutex_unlock(&crypt_stat
->cs_mutex
);
942 rc
= inode_change_ok(inode
, ia
);
945 if (ia
->ia_valid
& ATTR_SIZE
) {
946 rc
= ecryptfs_inode_newsize_ok(inode
, ia
->ia_size
);
951 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
952 if (ia
->ia_valid
& ATTR_FILE
)
953 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
954 if (ia
->ia_valid
& ATTR_SIZE
) {
955 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
961 * mode change is for clearing setuid/setgid bits. Allow lower fs
962 * to interpret this in its own way.
964 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
965 lower_ia
.ia_valid
&= ~ATTR_MODE
;
967 mutex_lock(&d_inode(lower_dentry
)->i_mutex
);
968 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
969 mutex_unlock(&d_inode(lower_dentry
)->i_mutex
);
971 fsstack_copy_attr_all(inode
, lower_inode
);
975 static int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
978 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
981 mount_crypt_stat
= &ecryptfs_superblock_to_private(
982 dentry
->d_sb
)->mount_crypt_stat
;
983 generic_fillattr(d_inode(dentry
), stat
);
984 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
988 target
= ecryptfs_readlink_lower(dentry
, &targetsiz
);
989 if (!IS_ERR(target
)) {
991 stat
->size
= targetsiz
;
993 rc
= PTR_ERR(target
);
999 static int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1002 struct kstat lower_stat
;
1005 rc
= vfs_getattr(ecryptfs_dentry_to_lower_path(dentry
), &lower_stat
);
1007 fsstack_copy_attr_all(d_inode(dentry
),
1008 ecryptfs_inode_to_lower(d_inode(dentry
)));
1009 generic_fillattr(d_inode(dentry
), stat
);
1010 stat
->blocks
= lower_stat
.blocks
;
1016 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1017 size_t size
, int flags
)
1020 struct dentry
*lower_dentry
;
1022 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1023 if (!d_inode(lower_dentry
)->i_op
->setxattr
) {
1028 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1029 if (!rc
&& d_really_is_positive(dentry
))
1030 fsstack_copy_attr_all(d_inode(dentry
), d_inode(lower_dentry
));
1036 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1037 void *value
, size_t size
)
1041 if (!d_inode(lower_dentry
)->i_op
->getxattr
) {
1045 mutex_lock(&d_inode(lower_dentry
)->i_mutex
);
1046 rc
= d_inode(lower_dentry
)->i_op
->getxattr(lower_dentry
, name
, value
,
1048 mutex_unlock(&d_inode(lower_dentry
)->i_mutex
);
1054 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1057 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1062 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1065 struct dentry
*lower_dentry
;
1067 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1068 if (!d_inode(lower_dentry
)->i_op
->listxattr
) {
1072 mutex_lock(&d_inode(lower_dentry
)->i_mutex
);
1073 rc
= d_inode(lower_dentry
)->i_op
->listxattr(lower_dentry
, list
, size
);
1074 mutex_unlock(&d_inode(lower_dentry
)->i_mutex
);
1079 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1082 struct dentry
*lower_dentry
;
1084 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1085 if (!d_inode(lower_dentry
)->i_op
->removexattr
) {
1089 mutex_lock(&d_inode(lower_dentry
)->i_mutex
);
1090 rc
= d_inode(lower_dentry
)->i_op
->removexattr(lower_dentry
, name
);
1091 mutex_unlock(&d_inode(lower_dentry
)->i_mutex
);
1096 const struct inode_operations ecryptfs_symlink_iops
= {
1097 .readlink
= generic_readlink
,
1098 .follow_link
= ecryptfs_follow_link
,
1099 .put_link
= kfree_put_link
,
1100 .permission
= ecryptfs_permission
,
1101 .setattr
= ecryptfs_setattr
,
1102 .getattr
= ecryptfs_getattr_link
,
1103 .setxattr
= ecryptfs_setxattr
,
1104 .getxattr
= ecryptfs_getxattr
,
1105 .listxattr
= ecryptfs_listxattr
,
1106 .removexattr
= ecryptfs_removexattr
1109 const struct inode_operations ecryptfs_dir_iops
= {
1110 .create
= ecryptfs_create
,
1111 .lookup
= ecryptfs_lookup
,
1112 .link
= ecryptfs_link
,
1113 .unlink
= ecryptfs_unlink
,
1114 .symlink
= ecryptfs_symlink
,
1115 .mkdir
= ecryptfs_mkdir
,
1116 .rmdir
= ecryptfs_rmdir
,
1117 .mknod
= ecryptfs_mknod
,
1118 .rename
= ecryptfs_rename
,
1119 .permission
= ecryptfs_permission
,
1120 .setattr
= ecryptfs_setattr
,
1121 .setxattr
= ecryptfs_setxattr
,
1122 .getxattr
= ecryptfs_getxattr
,
1123 .listxattr
= ecryptfs_listxattr
,
1124 .removexattr
= ecryptfs_removexattr
1127 const struct inode_operations ecryptfs_main_iops
= {
1128 .permission
= ecryptfs_permission
,
1129 .setattr
= ecryptfs_setattr
,
1130 .getattr
= ecryptfs_getattr
,
1131 .setxattr
= ecryptfs_setxattr
,
1132 .getxattr
= ecryptfs_getxattr
,
1133 .listxattr
= ecryptfs_listxattr
,
1134 .removexattr
= ecryptfs_removexattr