1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * eCryptfs: Linux filesystem encryption layer
5 * Copyright (C) 1997-2004 Erez Zadok
6 * Copyright (C) 2001-2004 Stony Brook University
7 * Copyright (C) 2004-2007 International Business Machines Corp.
8 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
9 * Michael C. Thompsion <mcthomps@us.ibm.com>
12 #include <linux/file.h>
13 #include <linux/vmalloc.h>
14 #include <linux/pagemap.h>
15 #include <linux/dcache.h>
16 #include <linux/namei.h>
17 #include <linux/mount.h>
18 #include <linux/fs_stack.h>
19 #include <linux/slab.h>
20 #include <linux/xattr.h>
21 #include <linux/posix_acl.h>
22 #include <linux/posix_acl_xattr.h>
23 #include <linux/fileattr.h>
24 #include <linux/unaligned.h>
25 #include "ecryptfs_kernel.h"
27 static int lock_parent(struct dentry
*dentry
,
28 struct dentry
**lower_dentry
,
29 struct inode
**lower_dir
)
31 struct dentry
*lower_dir_dentry
;
33 lower_dir_dentry
= ecryptfs_dentry_to_lower(dentry
->d_parent
);
34 *lower_dir
= d_inode(lower_dir_dentry
);
35 *lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
37 inode_lock_nested(*lower_dir
, I_MUTEX_PARENT
);
38 return (*lower_dentry
)->d_parent
== lower_dir_dentry
? 0 : -EINVAL
;
41 static int ecryptfs_inode_test(struct inode
*inode
, void *lower_inode
)
43 return ecryptfs_inode_to_lower(inode
) == lower_inode
;
46 static int ecryptfs_inode_set(struct inode
*inode
, void *opaque
)
48 struct inode
*lower_inode
= opaque
;
50 ecryptfs_set_inode_lower(inode
, lower_inode
);
51 fsstack_copy_attr_all(inode
, lower_inode
);
52 /* i_size will be overwritten for encrypted regular files */
53 fsstack_copy_inode_size(inode
, lower_inode
);
54 inode
->i_ino
= lower_inode
->i_ino
;
55 inode
->i_mapping
->a_ops
= &ecryptfs_aops
;
57 if (S_ISLNK(inode
->i_mode
))
58 inode
->i_op
= &ecryptfs_symlink_iops
;
59 else if (S_ISDIR(inode
->i_mode
))
60 inode
->i_op
= &ecryptfs_dir_iops
;
62 inode
->i_op
= &ecryptfs_main_iops
;
64 if (S_ISDIR(inode
->i_mode
))
65 inode
->i_fop
= &ecryptfs_dir_fops
;
66 else if (special_file(inode
->i_mode
))
67 init_special_inode(inode
, inode
->i_mode
, inode
->i_rdev
);
69 inode
->i_fop
= &ecryptfs_main_fops
;
74 static struct inode
*__ecryptfs_get_inode(struct inode
*lower_inode
,
75 struct super_block
*sb
)
79 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
))
80 return ERR_PTR(-EXDEV
);
82 /* Reject dealing with casefold directories. */
83 if (IS_CASEFOLDED(lower_inode
)) {
84 pr_err_ratelimited("%s: Can't handle casefolded directory.\n",
86 return ERR_PTR(-EREMOTE
);
89 if (!igrab(lower_inode
))
90 return ERR_PTR(-ESTALE
);
91 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
92 ecryptfs_inode_test
, ecryptfs_inode_set
,
96 return ERR_PTR(-EACCES
);
98 if (!(inode
->i_state
& I_NEW
))
104 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
105 struct super_block
*sb
)
107 struct inode
*inode
= __ecryptfs_get_inode(lower_inode
, sb
);
109 if (!IS_ERR(inode
) && (inode
->i_state
& I_NEW
))
110 unlock_new_inode(inode
);
117 * @lower_dentry: Existing dentry in the lower filesystem
118 * @dentry: ecryptfs' dentry
119 * @sb: ecryptfs's super_block
121 * Interposes upper and lower dentries.
123 * Returns zero on success; non-zero otherwise
125 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
126 struct dentry
*dentry
, struct super_block
*sb
)
128 struct inode
*inode
= ecryptfs_get_inode(d_inode(lower_dentry
), sb
);
131 return PTR_ERR(inode
);
132 d_instantiate(dentry
, inode
);
137 static int ecryptfs_do_unlink(struct inode
*dir
, struct dentry
*dentry
,
140 struct dentry
*lower_dentry
;
141 struct inode
*lower_dir
;
144 rc
= lock_parent(dentry
, &lower_dentry
, &lower_dir
);
145 dget(lower_dentry
); // don't even try to make the lower negative
147 if (d_unhashed(lower_dentry
))
150 rc
= vfs_unlink(&nop_mnt_idmap
, lower_dir
, lower_dentry
,
154 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
157 fsstack_copy_attr_times(dir
, lower_dir
);
158 set_nlink(inode
, ecryptfs_inode_to_lower(inode
)->i_nlink
);
159 inode_set_ctime_to_ts(inode
, inode_get_ctime(dir
));
162 inode_unlock(lower_dir
);
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 inode
*lower_dir
;
189 rc
= lock_parent(ecryptfs_dentry
, &lower_dentry
, &lower_dir
);
191 rc
= vfs_create(&nop_mnt_idmap
, lower_dir
,
192 lower_dentry
, mode
, true);
194 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
195 "rc = [%d]\n", __func__
, rc
);
199 inode
= __ecryptfs_get_inode(d_inode(lower_dentry
),
200 directory_inode
->i_sb
);
202 vfs_unlink(&nop_mnt_idmap
, lower_dir
, lower_dentry
, NULL
);
205 fsstack_copy_attr_times(directory_inode
, lower_dir
);
206 fsstack_copy_inode_size(directory_inode
, lower_dir
);
208 inode_unlock(lower_dir
);
213 * ecryptfs_initialize_file
215 * Cause the file to be changed from a basic empty file to an ecryptfs
216 * file with a header and first data page.
218 * Returns zero on success
220 int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
,
221 struct inode
*ecryptfs_inode
)
223 struct ecryptfs_crypt_stat
*crypt_stat
=
224 &ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
;
227 if (S_ISDIR(ecryptfs_inode
->i_mode
)) {
228 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
229 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
232 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
233 rc
= ecryptfs_new_file_context(ecryptfs_inode
);
235 ecryptfs_printk(KERN_ERR
, "Error creating new file "
236 "context; rc = [%d]\n", rc
);
239 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
, ecryptfs_inode
);
241 printk(KERN_ERR
"%s: Error attempting to initialize "
242 "the lower file for the dentry with name "
243 "[%pd]; rc = [%d]\n", __func__
,
244 ecryptfs_dentry
, rc
);
247 rc
= ecryptfs_write_metadata(ecryptfs_dentry
, ecryptfs_inode
);
249 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
250 ecryptfs_put_lower_file(ecryptfs_inode
);
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 mnt_idmap
*idmap
,
265 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 (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 iget_failed(ecryptfs_inode
);
288 d_instantiate_new(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 const struct path
*path
= ecryptfs_dentry_to_lower_path(dentry
->d_parent
);
331 struct inode
*inode
, *lower_inode
;
332 struct ecryptfs_dentry_info
*dentry_info
;
335 dentry_info
= kmem_cache_alloc(ecryptfs_dentry_info_cache
, GFP_KERNEL
);
338 return ERR_PTR(-ENOMEM
);
341 fsstack_copy_attr_atime(d_inode(dentry
->d_parent
),
342 d_inode(path
->dentry
));
343 BUG_ON(!d_count(lower_dentry
));
345 ecryptfs_set_dentry_private(dentry
, dentry_info
);
346 dentry_info
->lower_path
.mnt
= mntget(path
->mnt
);
347 dentry_info
->lower_path
.dentry
= lower_dentry
;
350 * negative dentry can go positive under us here - its parent is not
351 * locked. That's OK and that could happen just as we return from
352 * ecryptfs_lookup() anyway. Just need to be careful and fetch
353 * ->d_inode only once - it's not stable here.
355 lower_inode
= READ_ONCE(lower_dentry
->d_inode
);
358 /* We want to add because we couldn't find in lower */
362 inode
= __ecryptfs_get_inode(lower_inode
, dentry
->d_sb
);
364 printk(KERN_ERR
"%s: Error interposing; rc = [%ld]\n",
365 __func__
, PTR_ERR(inode
));
366 return ERR_CAST(inode
);
368 if (S_ISREG(inode
->i_mode
)) {
369 rc
= ecryptfs_i_size_read(dentry
, inode
);
371 make_bad_inode(inode
);
376 if (inode
->i_state
& I_NEW
)
377 unlock_new_inode(inode
);
378 return d_splice_alias(inode
, dentry
);
383 * @ecryptfs_dir_inode: The eCryptfs directory inode
384 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
385 * @flags: lookup flags
387 * Find a file on disk. If the file does not exist, then we'll add it to the
388 * dentry cache and continue on to read it from the disk.
390 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
391 struct dentry
*ecryptfs_dentry
,
394 char *encrypted_and_encoded_name
= NULL
;
395 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
396 struct dentry
*lower_dir_dentry
, *lower_dentry
;
397 const char *name
= ecryptfs_dentry
->d_name
.name
;
398 size_t len
= ecryptfs_dentry
->d_name
.len
;
402 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
404 mount_crypt_stat
= &ecryptfs_superblock_to_private(
405 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
406 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
407 rc
= ecryptfs_encrypt_and_encode_filename(
408 &encrypted_and_encoded_name
, &len
,
409 mount_crypt_stat
, name
, len
);
411 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
412 "filename; rc = [%d]\n", __func__
, rc
);
415 name
= encrypted_and_encoded_name
;
418 lower_dentry
= lookup_one_len_unlocked(name
, lower_dir_dentry
, len
);
419 if (IS_ERR(lower_dentry
)) {
420 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
421 "[%ld] on lower_dentry = [%s]\n", __func__
,
422 PTR_ERR(lower_dentry
),
424 res
= ERR_CAST(lower_dentry
);
426 res
= ecryptfs_lookup_interpose(ecryptfs_dentry
, lower_dentry
);
428 kfree(encrypted_and_encoded_name
);
432 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
433 struct dentry
*new_dentry
)
435 struct dentry
*lower_old_dentry
;
436 struct dentry
*lower_new_dentry
;
437 struct inode
*lower_dir
;
441 file_size_save
= i_size_read(d_inode(old_dentry
));
442 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
443 rc
= lock_parent(new_dentry
, &lower_new_dentry
, &lower_dir
);
445 rc
= vfs_link(lower_old_dentry
, &nop_mnt_idmap
, lower_dir
,
446 lower_new_dentry
, NULL
);
447 if (rc
|| d_really_is_negative(lower_new_dentry
))
449 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
);
452 fsstack_copy_attr_times(dir
, lower_dir
);
453 fsstack_copy_inode_size(dir
, lower_dir
);
454 set_nlink(d_inode(old_dentry
),
455 ecryptfs_inode_to_lower(d_inode(old_dentry
))->i_nlink
);
456 i_size_write(d_inode(new_dentry
), file_size_save
);
458 inode_unlock(lower_dir
);
462 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
464 return ecryptfs_do_unlink(dir
, dentry
, d_inode(dentry
));
467 static int ecryptfs_symlink(struct mnt_idmap
*idmap
,
468 struct inode
*dir
, struct dentry
*dentry
,
472 struct dentry
*lower_dentry
;
473 struct inode
*lower_dir
;
474 char *encoded_symname
;
475 size_t encoded_symlen
;
476 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
478 rc
= lock_parent(dentry
, &lower_dentry
, &lower_dir
);
481 mount_crypt_stat
= &ecryptfs_superblock_to_private(
482 dir
->i_sb
)->mount_crypt_stat
;
483 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
485 mount_crypt_stat
, symname
,
489 rc
= vfs_symlink(&nop_mnt_idmap
, lower_dir
, lower_dentry
,
491 kfree(encoded_symname
);
492 if (rc
|| d_really_is_negative(lower_dentry
))
494 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
497 fsstack_copy_attr_times(dir
, lower_dir
);
498 fsstack_copy_inode_size(dir
, lower_dir
);
500 inode_unlock(lower_dir
);
501 if (d_really_is_negative(dentry
))
506 static int ecryptfs_mkdir(struct mnt_idmap
*idmap
, struct inode
*dir
,
507 struct dentry
*dentry
, umode_t mode
)
510 struct dentry
*lower_dentry
;
511 struct inode
*lower_dir
;
513 rc
= lock_parent(dentry
, &lower_dentry
, &lower_dir
);
515 rc
= vfs_mkdir(&nop_mnt_idmap
, lower_dir
,
517 if (rc
|| d_really_is_negative(lower_dentry
))
519 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
522 fsstack_copy_attr_times(dir
, lower_dir
);
523 fsstack_copy_inode_size(dir
, lower_dir
);
524 set_nlink(dir
, lower_dir
->i_nlink
);
526 inode_unlock(lower_dir
);
527 if (d_really_is_negative(dentry
))
532 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
534 struct dentry
*lower_dentry
;
535 struct inode
*lower_dir
;
538 rc
= lock_parent(dentry
, &lower_dentry
, &lower_dir
);
539 dget(lower_dentry
); // don't even try to make the lower negative
541 if (d_unhashed(lower_dentry
))
544 rc
= vfs_rmdir(&nop_mnt_idmap
, lower_dir
, lower_dentry
);
547 clear_nlink(d_inode(dentry
));
548 fsstack_copy_attr_times(dir
, lower_dir
);
549 set_nlink(dir
, lower_dir
->i_nlink
);
552 inode_unlock(lower_dir
);
559 ecryptfs_mknod(struct mnt_idmap
*idmap
, struct inode
*dir
,
560 struct dentry
*dentry
, umode_t mode
, dev_t dev
)
563 struct dentry
*lower_dentry
;
564 struct inode
*lower_dir
;
566 rc
= lock_parent(dentry
, &lower_dentry
, &lower_dir
);
568 rc
= vfs_mknod(&nop_mnt_idmap
, lower_dir
,
569 lower_dentry
, mode
, dev
);
570 if (rc
|| d_really_is_negative(lower_dentry
))
572 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
575 fsstack_copy_attr_times(dir
, lower_dir
);
576 fsstack_copy_inode_size(dir
, lower_dir
);
578 inode_unlock(lower_dir
);
579 if (d_really_is_negative(dentry
))
585 ecryptfs_rename(struct mnt_idmap
*idmap
, struct inode
*old_dir
,
586 struct dentry
*old_dentry
, struct inode
*new_dir
,
587 struct dentry
*new_dentry
, unsigned int flags
)
590 struct dentry
*lower_old_dentry
;
591 struct dentry
*lower_new_dentry
;
592 struct dentry
*lower_old_dir_dentry
;
593 struct dentry
*lower_new_dir_dentry
;
595 struct inode
*target_inode
;
596 struct renamedata rd
= {};
601 lower_old_dir_dentry
= ecryptfs_dentry_to_lower(old_dentry
->d_parent
);
602 lower_new_dir_dentry
= ecryptfs_dentry_to_lower(new_dentry
->d_parent
);
604 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
605 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
607 target_inode
= d_inode(new_dentry
);
609 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
611 return PTR_ERR(trap
);
612 dget(lower_new_dentry
);
614 if (lower_old_dentry
->d_parent
!= lower_old_dir_dentry
)
616 if (lower_new_dentry
->d_parent
!= lower_new_dir_dentry
)
618 if (d_unhashed(lower_old_dentry
) || d_unhashed(lower_new_dentry
))
620 /* source should not be ancestor of target */
621 if (trap
== lower_old_dentry
)
623 /* target should not be ancestor of source */
624 if (trap
== lower_new_dentry
) {
629 rd
.old_mnt_idmap
= &nop_mnt_idmap
;
630 rd
.old_dir
= d_inode(lower_old_dir_dentry
);
631 rd
.old_dentry
= lower_old_dentry
;
632 rd
.new_mnt_idmap
= &nop_mnt_idmap
;
633 rd
.new_dir
= d_inode(lower_new_dir_dentry
);
634 rd
.new_dentry
= lower_new_dentry
;
635 rc
= vfs_rename(&rd
);
639 fsstack_copy_attr_all(target_inode
,
640 ecryptfs_inode_to_lower(target_inode
));
641 fsstack_copy_attr_all(new_dir
, d_inode(lower_new_dir_dentry
));
642 if (new_dir
!= old_dir
)
643 fsstack_copy_attr_all(old_dir
, d_inode(lower_old_dir_dentry
));
645 dput(lower_new_dentry
);
646 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
650 static char *ecryptfs_readlink_lower(struct dentry
*dentry
, size_t *bufsiz
)
652 DEFINE_DELAYED_CALL(done
);
653 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
658 link
= vfs_get_link(lower_dentry
, &done
);
660 return ERR_CAST(link
);
662 rc
= ecryptfs_decode_and_decrypt_filename(&buf
, bufsiz
, dentry
->d_sb
,
664 do_delayed_call(&done
);
671 static const char *ecryptfs_get_link(struct dentry
*dentry
,
673 struct delayed_call
*done
)
679 return ERR_PTR(-ECHILD
);
681 buf
= ecryptfs_readlink_lower(dentry
, &len
);
684 fsstack_copy_attr_atime(d_inode(dentry
),
685 d_inode(ecryptfs_dentry_to_lower(dentry
)));
687 set_delayed_call(done
, kfree_link
, buf
);
692 * upper_size_to_lower_size
693 * @crypt_stat: Crypt_stat associated with file
694 * @upper_size: Size of the upper file
696 * Calculate the required size of the lower file based on the
697 * specified size of the upper file. This calculation is based on the
698 * number of headers in the underlying file and the extent size.
700 * Returns Calculated size of the lower file.
703 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
708 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
709 if (upper_size
!= 0) {
712 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
713 if (upper_size
& ~crypt_stat
->extent_mask
)
715 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
722 * @dentry: The ecryptfs layer dentry
723 * @ia: Address of the ecryptfs inode's attributes
724 * @lower_ia: Address of the lower inode's attributes
726 * Function to handle truncations modifying the size of the file. Note
727 * that the file sizes are interpolated. When expanding, we are simply
728 * writing strings of 0's out. When truncating, we truncate the upper
729 * inode and update the lower_ia according to the page index
730 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
731 * the caller must use lower_ia in a call to notify_change() to perform
732 * the truncation of the lower inode.
734 * Returns zero on success; non-zero otherwise
736 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
737 struct iattr
*lower_ia
)
740 struct inode
*inode
= d_inode(dentry
);
741 struct ecryptfs_crypt_stat
*crypt_stat
;
742 loff_t i_size
= i_size_read(inode
);
743 loff_t lower_size_before_truncate
;
744 loff_t lower_size_after_truncate
;
746 if (unlikely((ia
->ia_size
== i_size
))) {
747 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
750 rc
= ecryptfs_get_lower_file(dentry
, inode
);
753 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
754 /* Switch on growing or shrinking file */
755 if (ia
->ia_size
> i_size
) {
756 char zero
[] = { 0x00 };
758 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
759 /* Write a single 0 at the last position of the file;
760 * this triggers code that will fill in 0's throughout
761 * the intermediate portion of the previous end of the
762 * file and the new and of the file */
763 rc
= ecryptfs_write(inode
, zero
,
764 (ia
->ia_size
- 1), 1);
765 } else { /* ia->ia_size < i_size_read(inode) */
766 /* We're chopping off all the pages down to the page
767 * in which ia->ia_size is located. Fill in the end of
768 * that page from (ia->ia_size & ~PAGE_MASK) to
769 * PAGE_SIZE with zeros. */
770 size_t num_zeros
= (PAGE_SIZE
771 - (ia
->ia_size
& ~PAGE_MASK
));
773 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
774 truncate_setsize(inode
, ia
->ia_size
);
775 lower_ia
->ia_size
= ia
->ia_size
;
776 lower_ia
->ia_valid
|= ATTR_SIZE
;
782 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
787 rc
= ecryptfs_write(inode
, zeros_virt
,
788 ia
->ia_size
, num_zeros
);
791 printk(KERN_ERR
"Error attempting to zero out "
792 "the remainder of the end page on "
793 "reducing truncate; rc = [%d]\n", rc
);
797 truncate_setsize(inode
, ia
->ia_size
);
798 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
800 printk(KERN_ERR
"Problem with "
801 "ecryptfs_write_inode_size_to_metadata; "
805 /* We are reducing the size of the ecryptfs file, and need to
806 * know if we need to reduce the size of the lower file. */
807 lower_size_before_truncate
=
808 upper_size_to_lower_size(crypt_stat
, i_size
);
809 lower_size_after_truncate
=
810 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
811 if (lower_size_after_truncate
< lower_size_before_truncate
) {
812 lower_ia
->ia_size
= lower_size_after_truncate
;
813 lower_ia
->ia_valid
|= ATTR_SIZE
;
815 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
818 ecryptfs_put_lower_file(inode
);
822 static int ecryptfs_inode_newsize_ok(struct inode
*inode
, loff_t offset
)
824 struct ecryptfs_crypt_stat
*crypt_stat
;
825 loff_t lower_oldsize
, lower_newsize
;
827 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
828 lower_oldsize
= upper_size_to_lower_size(crypt_stat
,
830 lower_newsize
= upper_size_to_lower_size(crypt_stat
, offset
);
831 if (lower_newsize
> lower_oldsize
) {
833 * The eCryptfs inode and the new *lower* size are mixed here
834 * because we may not have the lower i_mutex held and/or it may
835 * not be appropriate to call inode_newsize_ok() with inodes
836 * from other filesystems.
838 return inode_newsize_ok(inode
, lower_newsize
);
846 * @dentry: The ecryptfs layer dentry
847 * @new_length: The length to expand the file to
849 * Simple function that handles the truncation of an eCryptfs inode and
850 * its corresponding lower inode.
852 * Returns zero on success; non-zero otherwise
854 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
856 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
857 struct iattr lower_ia
= { .ia_valid
= 0 };
860 rc
= ecryptfs_inode_newsize_ok(d_inode(dentry
), new_length
);
864 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
865 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
866 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
868 inode_lock(d_inode(lower_dentry
));
869 rc
= notify_change(&nop_mnt_idmap
, lower_dentry
,
871 inode_unlock(d_inode(lower_dentry
));
877 ecryptfs_permission(struct mnt_idmap
*idmap
, struct inode
*inode
,
880 return inode_permission(&nop_mnt_idmap
,
881 ecryptfs_inode_to_lower(inode
), mask
);
886 * @idmap: idmap of the target mount
887 * @dentry: dentry handle to the inode to modify
888 * @ia: Structure with flags of what to change and values
890 * Updates the metadata of an inode. If the update is to the size
891 * i.e. truncation, then ecryptfs_truncate will handle the size modification
892 * of both the ecryptfs inode and the lower inode.
894 * All other metadata changes will be passed right to the lower filesystem,
895 * and we will just update our inode to look like the lower.
897 static int ecryptfs_setattr(struct mnt_idmap
*idmap
,
898 struct dentry
*dentry
, struct iattr
*ia
)
901 struct dentry
*lower_dentry
;
902 struct iattr lower_ia
;
904 struct inode
*lower_inode
;
905 struct ecryptfs_crypt_stat
*crypt_stat
;
907 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
908 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
)) {
909 rc
= ecryptfs_init_crypt_stat(crypt_stat
);
913 inode
= d_inode(dentry
);
914 lower_inode
= ecryptfs_inode_to_lower(inode
);
915 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
916 mutex_lock(&crypt_stat
->cs_mutex
);
917 if (d_is_dir(dentry
))
918 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
919 else if (d_is_reg(dentry
)
920 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
921 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
922 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
924 mount_crypt_stat
= &ecryptfs_superblock_to_private(
925 dentry
->d_sb
)->mount_crypt_stat
;
926 rc
= ecryptfs_get_lower_file(dentry
, inode
);
928 mutex_unlock(&crypt_stat
->cs_mutex
);
931 rc
= ecryptfs_read_metadata(dentry
);
932 ecryptfs_put_lower_file(inode
);
934 if (!(mount_crypt_stat
->flags
935 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
937 printk(KERN_WARNING
"Either the lower file "
938 "is not in a valid eCryptfs format, "
939 "or the key could not be retrieved. "
940 "Plaintext passthrough mode is not "
941 "enabled; returning -EIO\n");
942 mutex_unlock(&crypt_stat
->cs_mutex
);
946 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
947 | ECRYPTFS_ENCRYPTED
);
950 mutex_unlock(&crypt_stat
->cs_mutex
);
952 rc
= setattr_prepare(&nop_mnt_idmap
, dentry
, ia
);
955 if (ia
->ia_valid
& ATTR_SIZE
) {
956 rc
= ecryptfs_inode_newsize_ok(inode
, ia
->ia_size
);
961 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
962 if (ia
->ia_valid
& ATTR_FILE
)
963 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
964 if (ia
->ia_valid
& ATTR_SIZE
) {
965 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
971 * mode change is for clearing setuid/setgid bits. Allow lower fs
972 * to interpret this in its own way.
974 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
975 lower_ia
.ia_valid
&= ~ATTR_MODE
;
977 inode_lock(d_inode(lower_dentry
));
978 rc
= notify_change(&nop_mnt_idmap
, lower_dentry
, &lower_ia
, NULL
);
979 inode_unlock(d_inode(lower_dentry
));
981 fsstack_copy_attr_all(inode
, lower_inode
);
985 static int ecryptfs_getattr_link(struct mnt_idmap
*idmap
,
986 const struct path
*path
, struct kstat
*stat
,
987 u32 request_mask
, unsigned int flags
)
989 struct dentry
*dentry
= path
->dentry
;
990 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
993 mount_crypt_stat
= &ecryptfs_superblock_to_private(
994 dentry
->d_sb
)->mount_crypt_stat
;
995 generic_fillattr(&nop_mnt_idmap
, request_mask
, d_inode(dentry
), stat
);
996 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1000 target
= ecryptfs_readlink_lower(dentry
, &targetsiz
);
1001 if (!IS_ERR(target
)) {
1003 stat
->size
= targetsiz
;
1005 rc
= PTR_ERR(target
);
1011 static int ecryptfs_getattr(struct mnt_idmap
*idmap
,
1012 const struct path
*path
, struct kstat
*stat
,
1013 u32 request_mask
, unsigned int flags
)
1015 struct dentry
*dentry
= path
->dentry
;
1016 struct kstat lower_stat
;
1019 rc
= vfs_getattr_nosec(ecryptfs_dentry_to_lower_path(dentry
),
1020 &lower_stat
, request_mask
, flags
);
1022 fsstack_copy_attr_all(d_inode(dentry
),
1023 ecryptfs_inode_to_lower(d_inode(dentry
)));
1024 generic_fillattr(&nop_mnt_idmap
, request_mask
,
1025 d_inode(dentry
), stat
);
1026 stat
->blocks
= lower_stat
.blocks
;
1032 ecryptfs_setxattr(struct dentry
*dentry
, struct inode
*inode
,
1033 const char *name
, const void *value
,
1034 size_t size
, int flags
)
1037 struct dentry
*lower_dentry
;
1038 struct inode
*lower_inode
;
1040 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1041 lower_inode
= d_inode(lower_dentry
);
1042 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1046 inode_lock(lower_inode
);
1047 rc
= __vfs_setxattr_locked(&nop_mnt_idmap
, lower_dentry
, name
, value
, size
, flags
, NULL
);
1048 inode_unlock(lower_inode
);
1050 fsstack_copy_attr_all(inode
, lower_inode
);
1056 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, struct inode
*lower_inode
,
1057 const char *name
, void *value
, size_t size
)
1061 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1065 inode_lock(lower_inode
);
1066 rc
= __vfs_getxattr(lower_dentry
, lower_inode
, name
, value
, size
);
1067 inode_unlock(lower_inode
);
1073 ecryptfs_getxattr(struct dentry
*dentry
, struct inode
*inode
,
1074 const char *name
, void *value
, size_t size
)
1076 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
),
1077 ecryptfs_inode_to_lower(inode
),
1082 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1085 struct dentry
*lower_dentry
;
1087 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1088 if (!d_inode(lower_dentry
)->i_op
->listxattr
) {
1092 inode_lock(d_inode(lower_dentry
));
1093 rc
= d_inode(lower_dentry
)->i_op
->listxattr(lower_dentry
, list
, size
);
1094 inode_unlock(d_inode(lower_dentry
));
1099 static int ecryptfs_removexattr(struct dentry
*dentry
, struct inode
*inode
,
1103 struct dentry
*lower_dentry
;
1104 struct inode
*lower_inode
;
1106 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1107 lower_inode
= ecryptfs_inode_to_lower(inode
);
1108 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1112 inode_lock(lower_inode
);
1113 rc
= __vfs_removexattr(&nop_mnt_idmap
, lower_dentry
, name
);
1114 inode_unlock(lower_inode
);
1119 static int ecryptfs_fileattr_get(struct dentry
*dentry
, struct fileattr
*fa
)
1121 return vfs_fileattr_get(ecryptfs_dentry_to_lower(dentry
), fa
);
1124 static int ecryptfs_fileattr_set(struct mnt_idmap
*idmap
,
1125 struct dentry
*dentry
, struct fileattr
*fa
)
1127 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1130 rc
= vfs_fileattr_set(&nop_mnt_idmap
, lower_dentry
, fa
);
1131 fsstack_copy_attr_all(d_inode(dentry
), d_inode(lower_dentry
));
1136 static struct posix_acl
*ecryptfs_get_acl(struct mnt_idmap
*idmap
,
1137 struct dentry
*dentry
, int type
)
1139 return vfs_get_acl(idmap
, ecryptfs_dentry_to_lower(dentry
),
1140 posix_acl_xattr_name(type
));
1143 static int ecryptfs_set_acl(struct mnt_idmap
*idmap
,
1144 struct dentry
*dentry
, struct posix_acl
*acl
,
1148 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1149 struct inode
*lower_inode
= d_inode(lower_dentry
);
1151 rc
= vfs_set_acl(&nop_mnt_idmap
, lower_dentry
,
1152 posix_acl_xattr_name(type
), acl
);
1154 fsstack_copy_attr_all(d_inode(dentry
), lower_inode
);
1158 const struct inode_operations ecryptfs_symlink_iops
= {
1159 .get_link
= ecryptfs_get_link
,
1160 .permission
= ecryptfs_permission
,
1161 .setattr
= ecryptfs_setattr
,
1162 .getattr
= ecryptfs_getattr_link
,
1163 .listxattr
= ecryptfs_listxattr
,
1166 const struct inode_operations ecryptfs_dir_iops
= {
1167 .create
= ecryptfs_create
,
1168 .lookup
= ecryptfs_lookup
,
1169 .link
= ecryptfs_link
,
1170 .unlink
= ecryptfs_unlink
,
1171 .symlink
= ecryptfs_symlink
,
1172 .mkdir
= ecryptfs_mkdir
,
1173 .rmdir
= ecryptfs_rmdir
,
1174 .mknod
= ecryptfs_mknod
,
1175 .rename
= ecryptfs_rename
,
1176 .permission
= ecryptfs_permission
,
1177 .setattr
= ecryptfs_setattr
,
1178 .listxattr
= ecryptfs_listxattr
,
1179 .fileattr_get
= ecryptfs_fileattr_get
,
1180 .fileattr_set
= ecryptfs_fileattr_set
,
1181 .get_acl
= ecryptfs_get_acl
,
1182 .set_acl
= ecryptfs_set_acl
,
1185 const struct inode_operations ecryptfs_main_iops
= {
1186 .permission
= ecryptfs_permission
,
1187 .setattr
= ecryptfs_setattr
,
1188 .getattr
= ecryptfs_getattr
,
1189 .listxattr
= ecryptfs_listxattr
,
1190 .fileattr_get
= ecryptfs_fileattr_get
,
1191 .fileattr_set
= ecryptfs_fileattr_set
,
1192 .get_acl
= ecryptfs_get_acl
,
1193 .set_acl
= ecryptfs_set_acl
,
1196 static int ecryptfs_xattr_get(const struct xattr_handler
*handler
,
1197 struct dentry
*dentry
, struct inode
*inode
,
1198 const char *name
, void *buffer
, size_t size
)
1200 return ecryptfs_getxattr(dentry
, inode
, name
, buffer
, size
);
1203 static int ecryptfs_xattr_set(const struct xattr_handler
*handler
,
1204 struct mnt_idmap
*idmap
,
1205 struct dentry
*dentry
, struct inode
*inode
,
1206 const char *name
, const void *value
, size_t size
,
1210 return ecryptfs_setxattr(dentry
, inode
, name
, value
, size
, flags
);
1212 BUG_ON(flags
!= XATTR_REPLACE
);
1213 return ecryptfs_removexattr(dentry
, inode
, name
);
1217 static const struct xattr_handler ecryptfs_xattr_handler
= {
1218 .prefix
= "", /* match anything */
1219 .get
= ecryptfs_xattr_get
,
1220 .set
= ecryptfs_xattr_set
,
1223 const struct xattr_handler
* const ecryptfs_xattr_handlers
[] = {
1224 &ecryptfs_xattr_handler
,