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/fs_stack.h>
33 #include <linux/slab.h>
34 #include <linux/xattr.h>
35 #include <asm/unaligned.h>
36 #include "ecryptfs_kernel.h"
38 static struct dentry
*lock_parent(struct dentry
*dentry
)
42 dir
= dget_parent(dentry
);
43 inode_lock_nested(d_inode(dir
), I_MUTEX_PARENT
);
47 static void unlock_dir(struct dentry
*dir
)
49 inode_unlock(d_inode(dir
));
53 static int ecryptfs_inode_test(struct inode
*inode
, void *lower_inode
)
55 return ecryptfs_inode_to_lower(inode
) == lower_inode
;
58 static int ecryptfs_inode_set(struct inode
*inode
, void *opaque
)
60 struct inode
*lower_inode
= opaque
;
62 ecryptfs_set_inode_lower(inode
, lower_inode
);
63 fsstack_copy_attr_all(inode
, lower_inode
);
64 /* i_size will be overwritten for encrypted regular files */
65 fsstack_copy_inode_size(inode
, lower_inode
);
66 inode
->i_ino
= lower_inode
->i_ino
;
68 inode
->i_mapping
->a_ops
= &ecryptfs_aops
;
70 if (S_ISLNK(inode
->i_mode
))
71 inode
->i_op
= &ecryptfs_symlink_iops
;
72 else if (S_ISDIR(inode
->i_mode
))
73 inode
->i_op
= &ecryptfs_dir_iops
;
75 inode
->i_op
= &ecryptfs_main_iops
;
77 if (S_ISDIR(inode
->i_mode
))
78 inode
->i_fop
= &ecryptfs_dir_fops
;
79 else if (special_file(inode
->i_mode
))
80 init_special_inode(inode
, inode
->i_mode
, inode
->i_rdev
);
82 inode
->i_fop
= &ecryptfs_main_fops
;
87 static struct inode
*__ecryptfs_get_inode(struct inode
*lower_inode
,
88 struct super_block
*sb
)
92 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
))
93 return ERR_PTR(-EXDEV
);
94 if (!igrab(lower_inode
))
95 return ERR_PTR(-ESTALE
);
96 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
97 ecryptfs_inode_test
, ecryptfs_inode_set
,
101 return ERR_PTR(-EACCES
);
103 if (!(inode
->i_state
& I_NEW
))
109 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
110 struct super_block
*sb
)
112 struct inode
*inode
= __ecryptfs_get_inode(lower_inode
, sb
);
114 if (!IS_ERR(inode
) && (inode
->i_state
& I_NEW
))
115 unlock_new_inode(inode
);
122 * @lower_dentry: Existing dentry in the lower filesystem
123 * @dentry: ecryptfs' dentry
124 * @sb: ecryptfs's super_block
126 * Interposes upper and lower dentries.
128 * Returns zero on success; non-zero otherwise
130 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
131 struct dentry
*dentry
, struct super_block
*sb
)
133 struct inode
*inode
= ecryptfs_get_inode(d_inode(lower_dentry
), sb
);
136 return PTR_ERR(inode
);
137 d_instantiate(dentry
, inode
);
142 static int ecryptfs_do_unlink(struct inode
*dir
, struct dentry
*dentry
,
145 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
146 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
147 struct dentry
*lower_dir_dentry
;
151 lower_dir_dentry
= lock_parent(lower_dentry
);
152 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
, NULL
);
154 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
157 fsstack_copy_attr_times(dir
, lower_dir_inode
);
158 set_nlink(inode
, ecryptfs_inode_to_lower(inode
)->i_nlink
);
159 inode
->i_ctime
= dir
->i_ctime
;
162 unlock_dir(lower_dir_dentry
);
169 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
170 * @ecryptfs_dentry: New file's dentry in ecryptfs
171 * @mode: The mode of the new file
173 * Creates the underlying file and the eCryptfs inode which will link to
174 * it. It will also update the eCryptfs directory inode to mimic the
175 * stat of the lower directory inode.
177 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
179 static struct inode
*
180 ecryptfs_do_create(struct inode
*directory_inode
,
181 struct dentry
*ecryptfs_dentry
, umode_t mode
)
184 struct dentry
*lower_dentry
;
185 struct dentry
*lower_dir_dentry
;
188 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
189 lower_dir_dentry
= lock_parent(lower_dentry
);
190 rc
= vfs_create(d_inode(lower_dir_dentry
), lower_dentry
, mode
, true);
192 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
193 "rc = [%d]\n", __func__
, rc
);
197 inode
= __ecryptfs_get_inode(d_inode(lower_dentry
),
198 directory_inode
->i_sb
);
200 vfs_unlink(d_inode(lower_dir_dentry
), lower_dentry
, NULL
);
203 fsstack_copy_attr_times(directory_inode
, d_inode(lower_dir_dentry
));
204 fsstack_copy_inode_size(directory_inode
, d_inode(lower_dir_dentry
));
206 unlock_dir(lower_dir_dentry
);
211 * ecryptfs_initialize_file
213 * Cause the file to be changed from a basic empty file to an ecryptfs
214 * file with a header and first data page.
216 * Returns zero on success
218 int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
,
219 struct inode
*ecryptfs_inode
)
221 struct ecryptfs_crypt_stat
*crypt_stat
=
222 &ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
;
225 if (S_ISDIR(ecryptfs_inode
->i_mode
)) {
226 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
227 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
230 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
231 rc
= ecryptfs_new_file_context(ecryptfs_inode
);
233 ecryptfs_printk(KERN_ERR
, "Error creating new file "
234 "context; rc = [%d]\n", rc
);
237 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
, ecryptfs_inode
);
239 printk(KERN_ERR
"%s: Error attempting to initialize "
240 "the lower file for the dentry with name "
241 "[%pd]; rc = [%d]\n", __func__
,
242 ecryptfs_dentry
, rc
);
245 rc
= ecryptfs_write_metadata(ecryptfs_dentry
, ecryptfs_inode
);
247 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
248 ecryptfs_put_lower_file(ecryptfs_inode
);
255 * @dir: The inode of the directory in which to create the file.
256 * @dentry: The eCryptfs dentry
257 * @mode: The mode of the new file.
259 * Creates a new file.
261 * Returns zero on success; non-zero on error condition
264 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
265 umode_t mode
, bool excl
)
267 struct inode
*ecryptfs_inode
;
270 ecryptfs_inode
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
,
272 if (IS_ERR(ecryptfs_inode
)) {
273 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
274 "lower filesystem\n");
275 rc
= PTR_ERR(ecryptfs_inode
);
278 /* At this point, a file exists on "disk"; we need to make sure
279 * that this on disk file is prepared to be an ecryptfs file */
280 rc
= ecryptfs_initialize_file(ecryptfs_dentry
, ecryptfs_inode
);
282 ecryptfs_do_unlink(directory_inode
, ecryptfs_dentry
,
284 iget_failed(ecryptfs_inode
);
287 unlock_new_inode(ecryptfs_inode
);
288 d_instantiate(ecryptfs_dentry
, ecryptfs_inode
);
293 static int ecryptfs_i_size_read(struct dentry
*dentry
, struct inode
*inode
)
295 struct ecryptfs_crypt_stat
*crypt_stat
;
298 rc
= ecryptfs_get_lower_file(dentry
, inode
);
300 printk(KERN_ERR
"%s: Error attempting to initialize "
301 "the lower file for the dentry with name "
302 "[%pd]; rc = [%d]\n", __func__
,
307 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
308 /* TODO: lock for crypt_stat comparison */
309 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
310 ecryptfs_set_default_sizes(crypt_stat
);
312 rc
= ecryptfs_read_and_validate_header_region(inode
);
313 ecryptfs_put_lower_file(inode
);
315 rc
= ecryptfs_read_and_validate_xattr_region(dentry
, inode
);
317 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
320 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
325 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
327 static struct dentry
*ecryptfs_lookup_interpose(struct dentry
*dentry
,
328 struct dentry
*lower_dentry
)
330 struct inode
*inode
, *lower_inode
= d_inode(lower_dentry
);
331 struct ecryptfs_dentry_info
*dentry_info
;
332 struct vfsmount
*lower_mnt
;
335 dentry_info
= kmem_cache_alloc(ecryptfs_dentry_info_cache
, GFP_KERNEL
);
338 return ERR_PTR(-ENOMEM
);
341 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(dentry
->d_parent
));
342 fsstack_copy_attr_atime(d_inode(dentry
->d_parent
),
343 d_inode(lower_dentry
->d_parent
));
344 BUG_ON(!d_count(lower_dentry
));
346 ecryptfs_set_dentry_private(dentry
, dentry_info
);
347 dentry_info
->lower_path
.mnt
= lower_mnt
;
348 dentry_info
->lower_path
.dentry
= lower_dentry
;
350 if (d_really_is_negative(lower_dentry
)) {
351 /* We want to add because we couldn't find in lower */
355 inode
= __ecryptfs_get_inode(lower_inode
, dentry
->d_sb
);
357 printk(KERN_ERR
"%s: Error interposing; rc = [%ld]\n",
358 __func__
, PTR_ERR(inode
));
359 return ERR_CAST(inode
);
361 if (S_ISREG(inode
->i_mode
)) {
362 rc
= ecryptfs_i_size_read(dentry
, inode
);
364 make_bad_inode(inode
);
369 if (inode
->i_state
& I_NEW
)
370 unlock_new_inode(inode
);
371 return d_splice_alias(inode
, dentry
);
376 * @ecryptfs_dir_inode: The eCryptfs directory inode
377 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
378 * @flags: lookup flags
380 * Find a file on disk. If the file does not exist, then we'll add it to the
381 * dentry cache and continue on to read it from the disk.
383 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
384 struct dentry
*ecryptfs_dentry
,
387 char *encrypted_and_encoded_name
= NULL
;
388 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
389 struct dentry
*lower_dir_dentry
, *lower_dentry
;
390 const char *name
= ecryptfs_dentry
->d_name
.name
;
391 size_t len
= ecryptfs_dentry
->d_name
.len
;
395 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
397 mount_crypt_stat
= &ecryptfs_superblock_to_private(
398 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
400 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)) {
401 rc
= ecryptfs_encrypt_and_encode_filename(
402 &encrypted_and_encoded_name
, &len
,
403 mount_crypt_stat
, name
, len
);
405 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
406 "filename; rc = [%d]\n", __func__
, rc
);
409 name
= encrypted_and_encoded_name
;
412 lower_dentry
= lookup_one_len_unlocked(name
, lower_dir_dentry
, len
);
413 if (IS_ERR(lower_dentry
)) {
414 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
415 "[%ld] on lower_dentry = [%s]\n", __func__
,
416 PTR_ERR(lower_dentry
),
418 res
= ERR_CAST(lower_dentry
);
420 res
= ecryptfs_lookup_interpose(ecryptfs_dentry
, lower_dentry
);
422 kfree(encrypted_and_encoded_name
);
426 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
427 struct dentry
*new_dentry
)
429 struct dentry
*lower_old_dentry
;
430 struct dentry
*lower_new_dentry
;
431 struct dentry
*lower_dir_dentry
;
435 file_size_save
= i_size_read(d_inode(old_dentry
));
436 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
437 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
438 dget(lower_old_dentry
);
439 dget(lower_new_dentry
);
440 lower_dir_dentry
= lock_parent(lower_new_dentry
);
441 rc
= vfs_link(lower_old_dentry
, d_inode(lower_dir_dentry
),
442 lower_new_dentry
, NULL
);
443 if (rc
|| d_really_is_negative(lower_new_dentry
))
445 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
);
448 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
449 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
450 set_nlink(d_inode(old_dentry
),
451 ecryptfs_inode_to_lower(d_inode(old_dentry
))->i_nlink
);
452 i_size_write(d_inode(new_dentry
), file_size_save
);
454 unlock_dir(lower_dir_dentry
);
455 dput(lower_new_dentry
);
456 dput(lower_old_dentry
);
460 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
462 return ecryptfs_do_unlink(dir
, dentry
, d_inode(dentry
));
465 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
469 struct dentry
*lower_dentry
;
470 struct dentry
*lower_dir_dentry
;
471 char *encoded_symname
;
472 size_t encoded_symlen
;
473 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
475 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
477 lower_dir_dentry
= lock_parent(lower_dentry
);
478 mount_crypt_stat
= &ecryptfs_superblock_to_private(
479 dir
->i_sb
)->mount_crypt_stat
;
480 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
482 mount_crypt_stat
, symname
,
486 rc
= vfs_symlink(d_inode(lower_dir_dentry
), lower_dentry
,
488 kfree(encoded_symname
);
489 if (rc
|| d_really_is_negative(lower_dentry
))
491 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
494 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
495 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
497 unlock_dir(lower_dir_dentry
);
499 if (d_really_is_negative(dentry
))
504 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
507 struct dentry
*lower_dentry
;
508 struct dentry
*lower_dir_dentry
;
510 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
511 lower_dir_dentry
= lock_parent(lower_dentry
);
512 rc
= vfs_mkdir(d_inode(lower_dir_dentry
), lower_dentry
, mode
);
513 if (rc
|| d_really_is_negative(lower_dentry
))
515 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
518 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
519 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
520 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
522 unlock_dir(lower_dir_dentry
);
523 if (d_really_is_negative(dentry
))
528 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
530 struct dentry
*lower_dentry
;
531 struct dentry
*lower_dir_dentry
;
534 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
536 lower_dir_dentry
= lock_parent(lower_dentry
);
538 rc
= vfs_rmdir(d_inode(lower_dir_dentry
), lower_dentry
);
540 if (!rc
&& d_really_is_positive(dentry
))
541 clear_nlink(d_inode(dentry
));
542 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
543 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
544 unlock_dir(lower_dir_dentry
);
552 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
, dev_t dev
)
555 struct dentry
*lower_dentry
;
556 struct dentry
*lower_dir_dentry
;
558 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
559 lower_dir_dentry
= lock_parent(lower_dentry
);
560 rc
= vfs_mknod(d_inode(lower_dir_dentry
), lower_dentry
, mode
, dev
);
561 if (rc
|| d_really_is_negative(lower_dentry
))
563 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
566 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
567 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
569 unlock_dir(lower_dir_dentry
);
570 if (d_really_is_negative(dentry
))
576 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
577 struct inode
*new_dir
, struct dentry
*new_dentry
,
581 struct dentry
*lower_old_dentry
;
582 struct dentry
*lower_new_dentry
;
583 struct dentry
*lower_old_dir_dentry
;
584 struct dentry
*lower_new_dir_dentry
;
585 struct dentry
*trap
= NULL
;
586 struct inode
*target_inode
;
591 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
592 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
593 dget(lower_old_dentry
);
594 dget(lower_new_dentry
);
595 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
596 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
597 target_inode
= d_inode(new_dentry
);
598 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
599 /* source should not be ancestor of target */
600 if (trap
== lower_old_dentry
) {
604 /* target should not be ancestor of source */
605 if (trap
== lower_new_dentry
) {
609 rc
= vfs_rename(d_inode(lower_old_dir_dentry
), lower_old_dentry
,
610 d_inode(lower_new_dir_dentry
), lower_new_dentry
,
615 fsstack_copy_attr_all(target_inode
,
616 ecryptfs_inode_to_lower(target_inode
));
617 fsstack_copy_attr_all(new_dir
, d_inode(lower_new_dir_dentry
));
618 if (new_dir
!= old_dir
)
619 fsstack_copy_attr_all(old_dir
, d_inode(lower_old_dir_dentry
));
621 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
622 dput(lower_new_dir_dentry
);
623 dput(lower_old_dir_dentry
);
624 dput(lower_new_dentry
);
625 dput(lower_old_dentry
);
629 static char *ecryptfs_readlink_lower(struct dentry
*dentry
, size_t *bufsiz
)
631 DEFINE_DELAYED_CALL(done
);
632 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
637 link
= vfs_get_link(lower_dentry
, &done
);
639 return ERR_CAST(link
);
641 rc
= ecryptfs_decode_and_decrypt_filename(&buf
, bufsiz
, dentry
->d_sb
,
643 do_delayed_call(&done
);
650 static const char *ecryptfs_get_link(struct dentry
*dentry
,
652 struct delayed_call
*done
)
658 return ERR_PTR(-ECHILD
);
660 buf
= ecryptfs_readlink_lower(dentry
, &len
);
663 fsstack_copy_attr_atime(d_inode(dentry
),
664 d_inode(ecryptfs_dentry_to_lower(dentry
)));
666 set_delayed_call(done
, kfree_link
, buf
);
671 * upper_size_to_lower_size
672 * @crypt_stat: Crypt_stat associated with file
673 * @upper_size: Size of the upper file
675 * Calculate the required size of the lower file based on the
676 * specified size of the upper file. This calculation is based on the
677 * number of headers in the underlying file and the extent size.
679 * Returns Calculated size of the lower file.
682 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
687 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
688 if (upper_size
!= 0) {
691 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
692 if (upper_size
& ~crypt_stat
->extent_mask
)
694 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
701 * @dentry: The ecryptfs layer dentry
702 * @ia: Address of the ecryptfs inode's attributes
703 * @lower_ia: Address of the lower inode's attributes
705 * Function to handle truncations modifying the size of the file. Note
706 * that the file sizes are interpolated. When expanding, we are simply
707 * writing strings of 0's out. When truncating, we truncate the upper
708 * inode and update the lower_ia according to the page index
709 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
710 * the caller must use lower_ia in a call to notify_change() to perform
711 * the truncation of the lower inode.
713 * Returns zero on success; non-zero otherwise
715 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
716 struct iattr
*lower_ia
)
719 struct inode
*inode
= d_inode(dentry
);
720 struct ecryptfs_crypt_stat
*crypt_stat
;
721 loff_t i_size
= i_size_read(inode
);
722 loff_t lower_size_before_truncate
;
723 loff_t lower_size_after_truncate
;
725 if (unlikely((ia
->ia_size
== i_size
))) {
726 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
729 rc
= ecryptfs_get_lower_file(dentry
, inode
);
732 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
733 /* Switch on growing or shrinking file */
734 if (ia
->ia_size
> i_size
) {
735 char zero
[] = { 0x00 };
737 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
738 /* Write a single 0 at the last position of the file;
739 * this triggers code that will fill in 0's throughout
740 * the intermediate portion of the previous end of the
741 * file and the new and of the file */
742 rc
= ecryptfs_write(inode
, zero
,
743 (ia
->ia_size
- 1), 1);
744 } else { /* ia->ia_size < i_size_read(inode) */
745 /* We're chopping off all the pages down to the page
746 * in which ia->ia_size is located. Fill in the end of
747 * that page from (ia->ia_size & ~PAGE_MASK) to
748 * PAGE_SIZE with zeros. */
749 size_t num_zeros
= (PAGE_SIZE
750 - (ia
->ia_size
& ~PAGE_MASK
));
752 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
753 truncate_setsize(inode
, ia
->ia_size
);
754 lower_ia
->ia_size
= ia
->ia_size
;
755 lower_ia
->ia_valid
|= ATTR_SIZE
;
761 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
766 rc
= ecryptfs_write(inode
, zeros_virt
,
767 ia
->ia_size
, num_zeros
);
770 printk(KERN_ERR
"Error attempting to zero out "
771 "the remainder of the end page on "
772 "reducing truncate; rc = [%d]\n", rc
);
776 truncate_setsize(inode
, ia
->ia_size
);
777 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
779 printk(KERN_ERR
"Problem with "
780 "ecryptfs_write_inode_size_to_metadata; "
784 /* We are reducing the size of the ecryptfs file, and need to
785 * know if we need to reduce the size of the lower file. */
786 lower_size_before_truncate
=
787 upper_size_to_lower_size(crypt_stat
, i_size
);
788 lower_size_after_truncate
=
789 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
790 if (lower_size_after_truncate
< lower_size_before_truncate
) {
791 lower_ia
->ia_size
= lower_size_after_truncate
;
792 lower_ia
->ia_valid
|= ATTR_SIZE
;
794 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
797 ecryptfs_put_lower_file(inode
);
801 static int ecryptfs_inode_newsize_ok(struct inode
*inode
, loff_t offset
)
803 struct ecryptfs_crypt_stat
*crypt_stat
;
804 loff_t lower_oldsize
, lower_newsize
;
806 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
807 lower_oldsize
= upper_size_to_lower_size(crypt_stat
,
809 lower_newsize
= upper_size_to_lower_size(crypt_stat
, offset
);
810 if (lower_newsize
> lower_oldsize
) {
812 * The eCryptfs inode and the new *lower* size are mixed here
813 * because we may not have the lower i_mutex held and/or it may
814 * not be appropriate to call inode_newsize_ok() with inodes
815 * from other filesystems.
817 return inode_newsize_ok(inode
, lower_newsize
);
825 * @dentry: The ecryptfs layer dentry
826 * @new_length: The length to expand the file to
828 * Simple function that handles the truncation of an eCryptfs inode and
829 * its corresponding lower inode.
831 * Returns zero on success; non-zero otherwise
833 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
835 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
836 struct iattr lower_ia
= { .ia_valid
= 0 };
839 rc
= ecryptfs_inode_newsize_ok(d_inode(dentry
), new_length
);
843 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
844 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
845 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
847 inode_lock(d_inode(lower_dentry
));
848 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
849 inode_unlock(d_inode(lower_dentry
));
855 ecryptfs_permission(struct inode
*inode
, int mask
)
857 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
862 * @dentry: dentry handle to the inode to modify
863 * @ia: Structure with flags of what to change and values
865 * Updates the metadata of an inode. If the update is to the size
866 * i.e. truncation, then ecryptfs_truncate will handle the size modification
867 * of both the ecryptfs inode and the lower inode.
869 * All other metadata changes will be passed right to the lower filesystem,
870 * and we will just update our inode to look like the lower.
872 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
875 struct dentry
*lower_dentry
;
876 struct iattr lower_ia
;
878 struct inode
*lower_inode
;
879 struct ecryptfs_crypt_stat
*crypt_stat
;
881 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
882 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
)) {
883 rc
= ecryptfs_init_crypt_stat(crypt_stat
);
887 inode
= d_inode(dentry
);
888 lower_inode
= ecryptfs_inode_to_lower(inode
);
889 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
890 mutex_lock(&crypt_stat
->cs_mutex
);
891 if (d_is_dir(dentry
))
892 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
893 else if (d_is_reg(dentry
)
894 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
895 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
896 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
898 mount_crypt_stat
= &ecryptfs_superblock_to_private(
899 dentry
->d_sb
)->mount_crypt_stat
;
900 rc
= ecryptfs_get_lower_file(dentry
, inode
);
902 mutex_unlock(&crypt_stat
->cs_mutex
);
905 rc
= ecryptfs_read_metadata(dentry
);
906 ecryptfs_put_lower_file(inode
);
908 if (!(mount_crypt_stat
->flags
909 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
911 printk(KERN_WARNING
"Either the lower file "
912 "is not in a valid eCryptfs format, "
913 "or the key could not be retrieved. "
914 "Plaintext passthrough mode is not "
915 "enabled; returning -EIO\n");
916 mutex_unlock(&crypt_stat
->cs_mutex
);
920 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
921 | ECRYPTFS_ENCRYPTED
);
924 mutex_unlock(&crypt_stat
->cs_mutex
);
926 rc
= setattr_prepare(dentry
, ia
);
929 if (ia
->ia_valid
& ATTR_SIZE
) {
930 rc
= ecryptfs_inode_newsize_ok(inode
, ia
->ia_size
);
935 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
936 if (ia
->ia_valid
& ATTR_FILE
)
937 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
938 if (ia
->ia_valid
& ATTR_SIZE
) {
939 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
945 * mode change is for clearing setuid/setgid bits. Allow lower fs
946 * to interpret this in its own way.
948 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
949 lower_ia
.ia_valid
&= ~ATTR_MODE
;
951 inode_lock(d_inode(lower_dentry
));
952 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
953 inode_unlock(d_inode(lower_dentry
));
955 fsstack_copy_attr_all(inode
, lower_inode
);
959 static int ecryptfs_getattr_link(const struct path
*path
, struct kstat
*stat
,
960 u32 request_mask
, unsigned int flags
)
962 struct dentry
*dentry
= path
->dentry
;
963 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
966 mount_crypt_stat
= &ecryptfs_superblock_to_private(
967 dentry
->d_sb
)->mount_crypt_stat
;
968 generic_fillattr(d_inode(dentry
), stat
);
969 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
973 target
= ecryptfs_readlink_lower(dentry
, &targetsiz
);
974 if (!IS_ERR(target
)) {
976 stat
->size
= targetsiz
;
978 rc
= PTR_ERR(target
);
984 static int ecryptfs_getattr(const struct path
*path
, struct kstat
*stat
,
985 u32 request_mask
, unsigned int flags
)
987 struct dentry
*dentry
= path
->dentry
;
988 struct kstat lower_stat
;
991 rc
= vfs_getattr(ecryptfs_dentry_to_lower_path(dentry
), &lower_stat
,
992 request_mask
, flags
);
994 fsstack_copy_attr_all(d_inode(dentry
),
995 ecryptfs_inode_to_lower(d_inode(dentry
)));
996 generic_fillattr(d_inode(dentry
), stat
);
997 stat
->blocks
= lower_stat
.blocks
;
1003 ecryptfs_setxattr(struct dentry
*dentry
, struct inode
*inode
,
1004 const char *name
, const void *value
,
1005 size_t size
, int flags
)
1008 struct dentry
*lower_dentry
;
1010 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1011 if (!(d_inode(lower_dentry
)->i_opflags
& IOP_XATTR
)) {
1015 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1017 fsstack_copy_attr_all(inode
, d_inode(lower_dentry
));
1023 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, struct inode
*lower_inode
,
1024 const char *name
, void *value
, size_t size
)
1028 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1032 inode_lock(lower_inode
);
1033 rc
= __vfs_getxattr(lower_dentry
, lower_inode
, name
, value
, size
);
1034 inode_unlock(lower_inode
);
1040 ecryptfs_getxattr(struct dentry
*dentry
, struct inode
*inode
,
1041 const char *name
, void *value
, size_t size
)
1043 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
),
1044 ecryptfs_inode_to_lower(inode
),
1049 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1052 struct dentry
*lower_dentry
;
1054 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1055 if (!d_inode(lower_dentry
)->i_op
->listxattr
) {
1059 inode_lock(d_inode(lower_dentry
));
1060 rc
= d_inode(lower_dentry
)->i_op
->listxattr(lower_dentry
, list
, size
);
1061 inode_unlock(d_inode(lower_dentry
));
1066 static int ecryptfs_removexattr(struct dentry
*dentry
, struct inode
*inode
,
1070 struct dentry
*lower_dentry
;
1071 struct inode
*lower_inode
;
1073 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1074 lower_inode
= ecryptfs_inode_to_lower(inode
);
1075 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1079 inode_lock(lower_inode
);
1080 rc
= __vfs_removexattr(lower_dentry
, name
);
1081 inode_unlock(lower_inode
);
1086 const struct inode_operations ecryptfs_symlink_iops
= {
1087 .get_link
= ecryptfs_get_link
,
1088 .permission
= ecryptfs_permission
,
1089 .setattr
= ecryptfs_setattr
,
1090 .getattr
= ecryptfs_getattr_link
,
1091 .listxattr
= ecryptfs_listxattr
,
1094 const struct inode_operations ecryptfs_dir_iops
= {
1095 .create
= ecryptfs_create
,
1096 .lookup
= ecryptfs_lookup
,
1097 .link
= ecryptfs_link
,
1098 .unlink
= ecryptfs_unlink
,
1099 .symlink
= ecryptfs_symlink
,
1100 .mkdir
= ecryptfs_mkdir
,
1101 .rmdir
= ecryptfs_rmdir
,
1102 .mknod
= ecryptfs_mknod
,
1103 .rename
= ecryptfs_rename
,
1104 .permission
= ecryptfs_permission
,
1105 .setattr
= ecryptfs_setattr
,
1106 .listxattr
= ecryptfs_listxattr
,
1109 const struct inode_operations ecryptfs_main_iops
= {
1110 .permission
= ecryptfs_permission
,
1111 .setattr
= ecryptfs_setattr
,
1112 .getattr
= ecryptfs_getattr
,
1113 .listxattr
= ecryptfs_listxattr
,
1116 static int ecryptfs_xattr_get(const struct xattr_handler
*handler
,
1117 struct dentry
*dentry
, struct inode
*inode
,
1118 const char *name
, void *buffer
, size_t size
)
1120 return ecryptfs_getxattr(dentry
, inode
, name
, buffer
, size
);
1123 static int ecryptfs_xattr_set(const struct xattr_handler
*handler
,
1124 struct dentry
*dentry
, struct inode
*inode
,
1125 const char *name
, const void *value
, size_t size
,
1129 return ecryptfs_setxattr(dentry
, inode
, name
, value
, size
, flags
);
1131 BUG_ON(flags
!= XATTR_REPLACE
);
1132 return ecryptfs_removexattr(dentry
, inode
, name
);
1136 const struct xattr_handler ecryptfs_xattr_handler
= {
1137 .prefix
= "", /* match anything */
1138 .get
= ecryptfs_xattr_get
,
1139 .set
= ecryptfs_xattr_set
,
1142 const struct xattr_handler
*ecryptfs_xattr_handlers
[] = {
1143 &ecryptfs_xattr_handler
,