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
;
67 inode
->i_mapping
->a_ops
= &ecryptfs_aops
;
69 if (S_ISLNK(inode
->i_mode
))
70 inode
->i_op
= &ecryptfs_symlink_iops
;
71 else if (S_ISDIR(inode
->i_mode
))
72 inode
->i_op
= &ecryptfs_dir_iops
;
74 inode
->i_op
= &ecryptfs_main_iops
;
76 if (S_ISDIR(inode
->i_mode
))
77 inode
->i_fop
= &ecryptfs_dir_fops
;
78 else if (special_file(inode
->i_mode
))
79 init_special_inode(inode
, inode
->i_mode
, inode
->i_rdev
);
81 inode
->i_fop
= &ecryptfs_main_fops
;
86 static struct inode
*__ecryptfs_get_inode(struct inode
*lower_inode
,
87 struct super_block
*sb
)
91 if (lower_inode
->i_sb
!= ecryptfs_superblock_to_lower(sb
))
92 return ERR_PTR(-EXDEV
);
93 if (!igrab(lower_inode
))
94 return ERR_PTR(-ESTALE
);
95 inode
= iget5_locked(sb
, (unsigned long)lower_inode
,
96 ecryptfs_inode_test
, ecryptfs_inode_set
,
100 return ERR_PTR(-EACCES
);
102 if (!(inode
->i_state
& I_NEW
))
108 struct inode
*ecryptfs_get_inode(struct inode
*lower_inode
,
109 struct super_block
*sb
)
111 struct inode
*inode
= __ecryptfs_get_inode(lower_inode
, sb
);
113 if (!IS_ERR(inode
) && (inode
->i_state
& I_NEW
))
114 unlock_new_inode(inode
);
121 * @lower_dentry: Existing dentry in the lower filesystem
122 * @dentry: ecryptfs' dentry
123 * @sb: ecryptfs's super_block
125 * Interposes upper and lower dentries.
127 * Returns zero on success; non-zero otherwise
129 static int ecryptfs_interpose(struct dentry
*lower_dentry
,
130 struct dentry
*dentry
, struct super_block
*sb
)
132 struct inode
*inode
= ecryptfs_get_inode(d_inode(lower_dentry
), sb
);
135 return PTR_ERR(inode
);
136 d_instantiate(dentry
, inode
);
141 static int ecryptfs_do_unlink(struct inode
*dir
, struct dentry
*dentry
,
144 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
145 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
146 struct dentry
*lower_dir_dentry
;
150 lower_dir_dentry
= lock_parent(lower_dentry
);
151 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
, NULL
);
153 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
156 fsstack_copy_attr_times(dir
, lower_dir_inode
);
157 set_nlink(inode
, ecryptfs_inode_to_lower(inode
)->i_nlink
);
158 inode
->i_ctime
= dir
->i_ctime
;
161 unlock_dir(lower_dir_dentry
);
168 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
169 * @ecryptfs_dentry: New file's dentry in ecryptfs
170 * @mode: The mode of the new file
172 * Creates the underlying file and the eCryptfs inode which will link to
173 * it. It will also update the eCryptfs directory inode to mimic the
174 * stat of the lower directory inode.
176 * Returns the new eCryptfs inode on success; an ERR_PTR on error condition
178 static struct inode
*
179 ecryptfs_do_create(struct inode
*directory_inode
,
180 struct dentry
*ecryptfs_dentry
, umode_t mode
)
183 struct dentry
*lower_dentry
;
184 struct dentry
*lower_dir_dentry
;
187 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
188 lower_dir_dentry
= lock_parent(lower_dentry
);
189 rc
= vfs_create(d_inode(lower_dir_dentry
), lower_dentry
, mode
, true);
191 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
192 "rc = [%d]\n", __func__
, rc
);
196 inode
= __ecryptfs_get_inode(d_inode(lower_dentry
),
197 directory_inode
->i_sb
);
199 vfs_unlink(d_inode(lower_dir_dentry
), lower_dentry
, NULL
);
202 fsstack_copy_attr_times(directory_inode
, d_inode(lower_dir_dentry
));
203 fsstack_copy_inode_size(directory_inode
, d_inode(lower_dir_dentry
));
205 unlock_dir(lower_dir_dentry
);
210 * ecryptfs_initialize_file
212 * Cause the file to be changed from a basic empty file to an ecryptfs
213 * file with a header and first data page.
215 * Returns zero on success
217 int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
,
218 struct inode
*ecryptfs_inode
)
220 struct ecryptfs_crypt_stat
*crypt_stat
=
221 &ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
;
224 if (S_ISDIR(ecryptfs_inode
->i_mode
)) {
225 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
226 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
229 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
230 rc
= ecryptfs_new_file_context(ecryptfs_inode
);
232 ecryptfs_printk(KERN_ERR
, "Error creating new file "
233 "context; rc = [%d]\n", rc
);
236 rc
= ecryptfs_get_lower_file(ecryptfs_dentry
, ecryptfs_inode
);
238 printk(KERN_ERR
"%s: Error attempting to initialize "
239 "the lower file for the dentry with name "
240 "[%pd]; rc = [%d]\n", __func__
,
241 ecryptfs_dentry
, rc
);
244 rc
= ecryptfs_write_metadata(ecryptfs_dentry
, ecryptfs_inode
);
246 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
247 ecryptfs_put_lower_file(ecryptfs_inode
);
254 * @dir: The inode of the directory in which to create the file.
255 * @dentry: The eCryptfs dentry
256 * @mode: The mode of the new file.
258 * Creates a new file.
260 * Returns zero on success; non-zero on error condition
263 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
264 umode_t mode
, bool excl
)
266 struct inode
*ecryptfs_inode
;
269 ecryptfs_inode
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
,
271 if (IS_ERR(ecryptfs_inode
)) {
272 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
273 "lower filesystem\n");
274 rc
= PTR_ERR(ecryptfs_inode
);
277 /* At this point, a file exists on "disk"; we need to make sure
278 * that this on disk file is prepared to be an ecryptfs file */
279 rc
= ecryptfs_initialize_file(ecryptfs_dentry
, ecryptfs_inode
);
281 ecryptfs_do_unlink(directory_inode
, ecryptfs_dentry
,
283 iget_failed(ecryptfs_inode
);
286 d_instantiate_new(ecryptfs_dentry
, ecryptfs_inode
);
291 static int ecryptfs_i_size_read(struct dentry
*dentry
, struct inode
*inode
)
293 struct ecryptfs_crypt_stat
*crypt_stat
;
296 rc
= ecryptfs_get_lower_file(dentry
, inode
);
298 printk(KERN_ERR
"%s: Error attempting to initialize "
299 "the lower file for the dentry with name "
300 "[%pd]; rc = [%d]\n", __func__
,
305 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
306 /* TODO: lock for crypt_stat comparison */
307 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
308 ecryptfs_set_default_sizes(crypt_stat
);
310 rc
= ecryptfs_read_and_validate_header_region(inode
);
311 ecryptfs_put_lower_file(inode
);
313 rc
= ecryptfs_read_and_validate_xattr_region(dentry
, inode
);
315 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
318 /* Must return 0 to allow non-eCryptfs files to be looked up, too */
323 * ecryptfs_lookup_interpose - Dentry interposition for a lookup
325 static struct dentry
*ecryptfs_lookup_interpose(struct dentry
*dentry
,
326 struct dentry
*lower_dentry
)
328 struct inode
*inode
, *lower_inode
= d_inode(lower_dentry
);
329 struct ecryptfs_dentry_info
*dentry_info
;
330 struct vfsmount
*lower_mnt
;
333 dentry_info
= kmem_cache_alloc(ecryptfs_dentry_info_cache
, GFP_KERNEL
);
336 return ERR_PTR(-ENOMEM
);
339 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(dentry
->d_parent
));
340 fsstack_copy_attr_atime(d_inode(dentry
->d_parent
),
341 d_inode(lower_dentry
->d_parent
));
342 BUG_ON(!d_count(lower_dentry
));
344 ecryptfs_set_dentry_private(dentry
, dentry_info
);
345 dentry_info
->lower_path
.mnt
= lower_mnt
;
346 dentry_info
->lower_path
.dentry
= lower_dentry
;
348 if (d_really_is_negative(lower_dentry
)) {
349 /* We want to add because we couldn't find in lower */
353 inode
= __ecryptfs_get_inode(lower_inode
, dentry
->d_sb
);
355 printk(KERN_ERR
"%s: Error interposing; rc = [%ld]\n",
356 __func__
, PTR_ERR(inode
));
357 return ERR_CAST(inode
);
359 if (S_ISREG(inode
->i_mode
)) {
360 rc
= ecryptfs_i_size_read(dentry
, inode
);
362 make_bad_inode(inode
);
367 if (inode
->i_state
& I_NEW
)
368 unlock_new_inode(inode
);
369 return d_splice_alias(inode
, dentry
);
374 * @ecryptfs_dir_inode: The eCryptfs directory inode
375 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
376 * @flags: lookup flags
378 * Find a file on disk. If the file does not exist, then we'll add it to the
379 * dentry cache and continue on to read it from the disk.
381 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
382 struct dentry
*ecryptfs_dentry
,
385 char *encrypted_and_encoded_name
= NULL
;
386 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
387 struct dentry
*lower_dir_dentry
, *lower_dentry
;
388 const char *name
= ecryptfs_dentry
->d_name
.name
;
389 size_t len
= ecryptfs_dentry
->d_name
.len
;
393 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
395 mount_crypt_stat
= &ecryptfs_superblock_to_private(
396 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
397 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
398 rc
= ecryptfs_encrypt_and_encode_filename(
399 &encrypted_and_encoded_name
, &len
,
400 mount_crypt_stat
, name
, len
);
402 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
403 "filename; rc = [%d]\n", __func__
, rc
);
406 name
= encrypted_and_encoded_name
;
409 lower_dentry
= lookup_one_len_unlocked(name
, lower_dir_dentry
, len
);
410 if (IS_ERR(lower_dentry
)) {
411 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_len() returned "
412 "[%ld] on lower_dentry = [%s]\n", __func__
,
413 PTR_ERR(lower_dentry
),
415 res
= ERR_CAST(lower_dentry
);
417 res
= ecryptfs_lookup_interpose(ecryptfs_dentry
, lower_dentry
);
419 kfree(encrypted_and_encoded_name
);
423 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
424 struct dentry
*new_dentry
)
426 struct dentry
*lower_old_dentry
;
427 struct dentry
*lower_new_dentry
;
428 struct dentry
*lower_dir_dentry
;
432 file_size_save
= i_size_read(d_inode(old_dentry
));
433 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
434 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
435 dget(lower_old_dentry
);
436 dget(lower_new_dentry
);
437 lower_dir_dentry
= lock_parent(lower_new_dentry
);
438 rc
= vfs_link(lower_old_dentry
, d_inode(lower_dir_dentry
),
439 lower_new_dentry
, NULL
);
440 if (rc
|| d_really_is_negative(lower_new_dentry
))
442 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
);
445 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
446 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
447 set_nlink(d_inode(old_dentry
),
448 ecryptfs_inode_to_lower(d_inode(old_dentry
))->i_nlink
);
449 i_size_write(d_inode(new_dentry
), file_size_save
);
451 unlock_dir(lower_dir_dentry
);
452 dput(lower_new_dentry
);
453 dput(lower_old_dentry
);
457 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
459 return ecryptfs_do_unlink(dir
, dentry
, d_inode(dentry
));
462 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
466 struct dentry
*lower_dentry
;
467 struct dentry
*lower_dir_dentry
;
468 char *encoded_symname
;
469 size_t encoded_symlen
;
470 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
472 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
474 lower_dir_dentry
= lock_parent(lower_dentry
);
475 mount_crypt_stat
= &ecryptfs_superblock_to_private(
476 dir
->i_sb
)->mount_crypt_stat
;
477 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
479 mount_crypt_stat
, symname
,
483 rc
= vfs_symlink(d_inode(lower_dir_dentry
), lower_dentry
,
485 kfree(encoded_symname
);
486 if (rc
|| d_really_is_negative(lower_dentry
))
488 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
491 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
492 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
494 unlock_dir(lower_dir_dentry
);
496 if (d_really_is_negative(dentry
))
501 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
)
504 struct dentry
*lower_dentry
;
505 struct dentry
*lower_dir_dentry
;
507 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
508 lower_dir_dentry
= lock_parent(lower_dentry
);
509 rc
= vfs_mkdir(d_inode(lower_dir_dentry
), lower_dentry
, mode
);
510 if (rc
|| d_really_is_negative(lower_dentry
))
512 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
515 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
516 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
517 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
519 unlock_dir(lower_dir_dentry
);
520 if (d_really_is_negative(dentry
))
525 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
527 struct dentry
*lower_dentry
;
528 struct dentry
*lower_dir_dentry
;
531 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
533 lower_dir_dentry
= lock_parent(lower_dentry
);
535 rc
= vfs_rmdir(d_inode(lower_dir_dentry
), lower_dentry
);
537 if (!rc
&& d_really_is_positive(dentry
))
538 clear_nlink(d_inode(dentry
));
539 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
540 set_nlink(dir
, d_inode(lower_dir_dentry
)->i_nlink
);
541 unlock_dir(lower_dir_dentry
);
549 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, umode_t mode
, dev_t dev
)
552 struct dentry
*lower_dentry
;
553 struct dentry
*lower_dir_dentry
;
555 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
556 lower_dir_dentry
= lock_parent(lower_dentry
);
557 rc
= vfs_mknod(d_inode(lower_dir_dentry
), lower_dentry
, mode
, dev
);
558 if (rc
|| d_really_is_negative(lower_dentry
))
560 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
);
563 fsstack_copy_attr_times(dir
, d_inode(lower_dir_dentry
));
564 fsstack_copy_inode_size(dir
, d_inode(lower_dir_dentry
));
566 unlock_dir(lower_dir_dentry
);
567 if (d_really_is_negative(dentry
))
573 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
574 struct inode
*new_dir
, struct dentry
*new_dentry
,
578 struct dentry
*lower_old_dentry
;
579 struct dentry
*lower_new_dentry
;
580 struct dentry
*lower_old_dir_dentry
;
581 struct dentry
*lower_new_dir_dentry
;
582 struct dentry
*trap
= NULL
;
583 struct inode
*target_inode
;
588 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
589 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
590 dget(lower_old_dentry
);
591 dget(lower_new_dentry
);
592 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
593 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
594 target_inode
= d_inode(new_dentry
);
595 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
597 if (lower_old_dentry
->d_parent
!= lower_old_dir_dentry
)
599 if (lower_new_dentry
->d_parent
!= lower_new_dir_dentry
)
601 if (d_unhashed(lower_old_dentry
) || d_unhashed(lower_new_dentry
))
603 /* source should not be ancestor of target */
604 if (trap
== lower_old_dentry
)
606 /* target should not be ancestor of source */
607 if (trap
== lower_new_dentry
) {
611 rc
= vfs_rename(d_inode(lower_old_dir_dentry
), lower_old_dentry
,
612 d_inode(lower_new_dir_dentry
), lower_new_dentry
,
617 fsstack_copy_attr_all(target_inode
,
618 ecryptfs_inode_to_lower(target_inode
));
619 fsstack_copy_attr_all(new_dir
, d_inode(lower_new_dir_dentry
));
620 if (new_dir
!= old_dir
)
621 fsstack_copy_attr_all(old_dir
, d_inode(lower_old_dir_dentry
));
623 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
624 dput(lower_new_dir_dentry
);
625 dput(lower_old_dir_dentry
);
626 dput(lower_new_dentry
);
627 dput(lower_old_dentry
);
631 static char *ecryptfs_readlink_lower(struct dentry
*dentry
, size_t *bufsiz
)
633 DEFINE_DELAYED_CALL(done
);
634 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
639 link
= vfs_get_link(lower_dentry
, &done
);
641 return ERR_CAST(link
);
643 rc
= ecryptfs_decode_and_decrypt_filename(&buf
, bufsiz
, dentry
->d_sb
,
645 do_delayed_call(&done
);
652 static const char *ecryptfs_get_link(struct dentry
*dentry
,
654 struct delayed_call
*done
)
660 return ERR_PTR(-ECHILD
);
662 buf
= ecryptfs_readlink_lower(dentry
, &len
);
665 fsstack_copy_attr_atime(d_inode(dentry
),
666 d_inode(ecryptfs_dentry_to_lower(dentry
)));
668 set_delayed_call(done
, kfree_link
, buf
);
673 * upper_size_to_lower_size
674 * @crypt_stat: Crypt_stat associated with file
675 * @upper_size: Size of the upper file
677 * Calculate the required size of the lower file based on the
678 * specified size of the upper file. This calculation is based on the
679 * number of headers in the underlying file and the extent size.
681 * Returns Calculated size of the lower file.
684 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
689 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
690 if (upper_size
!= 0) {
693 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
694 if (upper_size
& ~crypt_stat
->extent_mask
)
696 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
703 * @dentry: The ecryptfs layer dentry
704 * @ia: Address of the ecryptfs inode's attributes
705 * @lower_ia: Address of the lower inode's attributes
707 * Function to handle truncations modifying the size of the file. Note
708 * that the file sizes are interpolated. When expanding, we are simply
709 * writing strings of 0's out. When truncating, we truncate the upper
710 * inode and update the lower_ia according to the page index
711 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
712 * the caller must use lower_ia in a call to notify_change() to perform
713 * the truncation of the lower inode.
715 * Returns zero on success; non-zero otherwise
717 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
718 struct iattr
*lower_ia
)
721 struct inode
*inode
= d_inode(dentry
);
722 struct ecryptfs_crypt_stat
*crypt_stat
;
723 loff_t i_size
= i_size_read(inode
);
724 loff_t lower_size_before_truncate
;
725 loff_t lower_size_after_truncate
;
727 if (unlikely((ia
->ia_size
== i_size
))) {
728 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
731 rc
= ecryptfs_get_lower_file(dentry
, inode
);
734 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
735 /* Switch on growing or shrinking file */
736 if (ia
->ia_size
> i_size
) {
737 char zero
[] = { 0x00 };
739 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
740 /* Write a single 0 at the last position of the file;
741 * this triggers code that will fill in 0's throughout
742 * the intermediate portion of the previous end of the
743 * file and the new and of the file */
744 rc
= ecryptfs_write(inode
, zero
,
745 (ia
->ia_size
- 1), 1);
746 } else { /* ia->ia_size < i_size_read(inode) */
747 /* We're chopping off all the pages down to the page
748 * in which ia->ia_size is located. Fill in the end of
749 * that page from (ia->ia_size & ~PAGE_MASK) to
750 * PAGE_SIZE with zeros. */
751 size_t num_zeros
= (PAGE_SIZE
752 - (ia
->ia_size
& ~PAGE_MASK
));
754 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
755 truncate_setsize(inode
, ia
->ia_size
);
756 lower_ia
->ia_size
= ia
->ia_size
;
757 lower_ia
->ia_valid
|= ATTR_SIZE
;
763 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
768 rc
= ecryptfs_write(inode
, zeros_virt
,
769 ia
->ia_size
, num_zeros
);
772 printk(KERN_ERR
"Error attempting to zero out "
773 "the remainder of the end page on "
774 "reducing truncate; rc = [%d]\n", rc
);
778 truncate_setsize(inode
, ia
->ia_size
);
779 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
781 printk(KERN_ERR
"Problem with "
782 "ecryptfs_write_inode_size_to_metadata; "
786 /* We are reducing the size of the ecryptfs file, and need to
787 * know if we need to reduce the size of the lower file. */
788 lower_size_before_truncate
=
789 upper_size_to_lower_size(crypt_stat
, i_size
);
790 lower_size_after_truncate
=
791 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
792 if (lower_size_after_truncate
< lower_size_before_truncate
) {
793 lower_ia
->ia_size
= lower_size_after_truncate
;
794 lower_ia
->ia_valid
|= ATTR_SIZE
;
796 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
799 ecryptfs_put_lower_file(inode
);
803 static int ecryptfs_inode_newsize_ok(struct inode
*inode
, loff_t offset
)
805 struct ecryptfs_crypt_stat
*crypt_stat
;
806 loff_t lower_oldsize
, lower_newsize
;
808 crypt_stat
= &ecryptfs_inode_to_private(inode
)->crypt_stat
;
809 lower_oldsize
= upper_size_to_lower_size(crypt_stat
,
811 lower_newsize
= upper_size_to_lower_size(crypt_stat
, offset
);
812 if (lower_newsize
> lower_oldsize
) {
814 * The eCryptfs inode and the new *lower* size are mixed here
815 * because we may not have the lower i_mutex held and/or it may
816 * not be appropriate to call inode_newsize_ok() with inodes
817 * from other filesystems.
819 return inode_newsize_ok(inode
, lower_newsize
);
827 * @dentry: The ecryptfs layer dentry
828 * @new_length: The length to expand the file to
830 * Simple function that handles the truncation of an eCryptfs inode and
831 * its corresponding lower inode.
833 * Returns zero on success; non-zero otherwise
835 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
837 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
838 struct iattr lower_ia
= { .ia_valid
= 0 };
841 rc
= ecryptfs_inode_newsize_ok(d_inode(dentry
), new_length
);
845 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
846 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
847 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
849 inode_lock(d_inode(lower_dentry
));
850 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
851 inode_unlock(d_inode(lower_dentry
));
857 ecryptfs_permission(struct inode
*inode
, int mask
)
859 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
864 * @dentry: dentry handle to the inode to modify
865 * @ia: Structure with flags of what to change and values
867 * Updates the metadata of an inode. If the update is to the size
868 * i.e. truncation, then ecryptfs_truncate will handle the size modification
869 * of both the ecryptfs inode and the lower inode.
871 * All other metadata changes will be passed right to the lower filesystem,
872 * and we will just update our inode to look like the lower.
874 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
877 struct dentry
*lower_dentry
;
878 struct iattr lower_ia
;
880 struct inode
*lower_inode
;
881 struct ecryptfs_crypt_stat
*crypt_stat
;
883 crypt_stat
= &ecryptfs_inode_to_private(d_inode(dentry
))->crypt_stat
;
884 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
)) {
885 rc
= ecryptfs_init_crypt_stat(crypt_stat
);
889 inode
= d_inode(dentry
);
890 lower_inode
= ecryptfs_inode_to_lower(inode
);
891 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
892 mutex_lock(&crypt_stat
->cs_mutex
);
893 if (d_is_dir(dentry
))
894 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
895 else if (d_is_reg(dentry
)
896 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
897 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
898 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
900 mount_crypt_stat
= &ecryptfs_superblock_to_private(
901 dentry
->d_sb
)->mount_crypt_stat
;
902 rc
= ecryptfs_get_lower_file(dentry
, inode
);
904 mutex_unlock(&crypt_stat
->cs_mutex
);
907 rc
= ecryptfs_read_metadata(dentry
);
908 ecryptfs_put_lower_file(inode
);
910 if (!(mount_crypt_stat
->flags
911 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
913 printk(KERN_WARNING
"Either the lower file "
914 "is not in a valid eCryptfs format, "
915 "or the key could not be retrieved. "
916 "Plaintext passthrough mode is not "
917 "enabled; returning -EIO\n");
918 mutex_unlock(&crypt_stat
->cs_mutex
);
922 crypt_stat
->flags
&= ~(ECRYPTFS_I_SIZE_INITIALIZED
923 | ECRYPTFS_ENCRYPTED
);
926 mutex_unlock(&crypt_stat
->cs_mutex
);
928 rc
= setattr_prepare(dentry
, ia
);
931 if (ia
->ia_valid
& ATTR_SIZE
) {
932 rc
= ecryptfs_inode_newsize_ok(inode
, ia
->ia_size
);
937 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
938 if (ia
->ia_valid
& ATTR_FILE
)
939 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
940 if (ia
->ia_valid
& ATTR_SIZE
) {
941 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
947 * mode change is for clearing setuid/setgid bits. Allow lower fs
948 * to interpret this in its own way.
950 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
951 lower_ia
.ia_valid
&= ~ATTR_MODE
;
953 inode_lock(d_inode(lower_dentry
));
954 rc
= notify_change(lower_dentry
, &lower_ia
, NULL
);
955 inode_unlock(d_inode(lower_dentry
));
957 fsstack_copy_attr_all(inode
, lower_inode
);
961 static int ecryptfs_getattr_link(const struct path
*path
, struct kstat
*stat
,
962 u32 request_mask
, unsigned int flags
)
964 struct dentry
*dentry
= path
->dentry
;
965 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
968 mount_crypt_stat
= &ecryptfs_superblock_to_private(
969 dentry
->d_sb
)->mount_crypt_stat
;
970 generic_fillattr(d_inode(dentry
), stat
);
971 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
975 target
= ecryptfs_readlink_lower(dentry
, &targetsiz
);
976 if (!IS_ERR(target
)) {
978 stat
->size
= targetsiz
;
980 rc
= PTR_ERR(target
);
986 static int ecryptfs_getattr(const struct path
*path
, struct kstat
*stat
,
987 u32 request_mask
, unsigned int flags
)
989 struct dentry
*dentry
= path
->dentry
;
990 struct kstat lower_stat
;
993 rc
= vfs_getattr(ecryptfs_dentry_to_lower_path(dentry
), &lower_stat
,
994 request_mask
, flags
);
996 fsstack_copy_attr_all(d_inode(dentry
),
997 ecryptfs_inode_to_lower(d_inode(dentry
)));
998 generic_fillattr(d_inode(dentry
), stat
);
999 stat
->blocks
= lower_stat
.blocks
;
1005 ecryptfs_setxattr(struct dentry
*dentry
, struct inode
*inode
,
1006 const char *name
, const void *value
,
1007 size_t size
, int flags
)
1010 struct dentry
*lower_dentry
;
1012 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1013 if (!(d_inode(lower_dentry
)->i_opflags
& IOP_XATTR
)) {
1017 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1019 fsstack_copy_attr_all(inode
, d_inode(lower_dentry
));
1025 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, struct inode
*lower_inode
,
1026 const char *name
, void *value
, size_t size
)
1030 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1034 inode_lock(lower_inode
);
1035 rc
= __vfs_getxattr(lower_dentry
, lower_inode
, name
, value
, size
);
1036 inode_unlock(lower_inode
);
1042 ecryptfs_getxattr(struct dentry
*dentry
, struct inode
*inode
,
1043 const char *name
, void *value
, size_t size
)
1045 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
),
1046 ecryptfs_inode_to_lower(inode
),
1051 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1054 struct dentry
*lower_dentry
;
1056 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1057 if (!d_inode(lower_dentry
)->i_op
->listxattr
) {
1061 inode_lock(d_inode(lower_dentry
));
1062 rc
= d_inode(lower_dentry
)->i_op
->listxattr(lower_dentry
, list
, size
);
1063 inode_unlock(d_inode(lower_dentry
));
1068 static int ecryptfs_removexattr(struct dentry
*dentry
, struct inode
*inode
,
1072 struct dentry
*lower_dentry
;
1073 struct inode
*lower_inode
;
1075 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1076 lower_inode
= ecryptfs_inode_to_lower(inode
);
1077 if (!(lower_inode
->i_opflags
& IOP_XATTR
)) {
1081 inode_lock(lower_inode
);
1082 rc
= __vfs_removexattr(lower_dentry
, name
);
1083 inode_unlock(lower_inode
);
1088 const struct inode_operations ecryptfs_symlink_iops
= {
1089 .get_link
= ecryptfs_get_link
,
1090 .permission
= ecryptfs_permission
,
1091 .setattr
= ecryptfs_setattr
,
1092 .getattr
= ecryptfs_getattr_link
,
1093 .listxattr
= ecryptfs_listxattr
,
1096 const struct inode_operations ecryptfs_dir_iops
= {
1097 .create
= ecryptfs_create
,
1098 .lookup
= ecryptfs_lookup
,
1099 .link
= ecryptfs_link
,
1100 .unlink
= ecryptfs_unlink
,
1101 .symlink
= ecryptfs_symlink
,
1102 .mkdir
= ecryptfs_mkdir
,
1103 .rmdir
= ecryptfs_rmdir
,
1104 .mknod
= ecryptfs_mknod
,
1105 .rename
= ecryptfs_rename
,
1106 .permission
= ecryptfs_permission
,
1107 .setattr
= ecryptfs_setattr
,
1108 .listxattr
= ecryptfs_listxattr
,
1111 const struct inode_operations ecryptfs_main_iops
= {
1112 .permission
= ecryptfs_permission
,
1113 .setattr
= ecryptfs_setattr
,
1114 .getattr
= ecryptfs_getattr
,
1115 .listxattr
= ecryptfs_listxattr
,
1118 static int ecryptfs_xattr_get(const struct xattr_handler
*handler
,
1119 struct dentry
*dentry
, struct inode
*inode
,
1120 const char *name
, void *buffer
, size_t size
)
1122 return ecryptfs_getxattr(dentry
, inode
, name
, buffer
, size
);
1125 static int ecryptfs_xattr_set(const struct xattr_handler
*handler
,
1126 struct dentry
*dentry
, struct inode
*inode
,
1127 const char *name
, const void *value
, size_t size
,
1131 return ecryptfs_setxattr(dentry
, inode
, name
, value
, size
, flags
);
1133 BUG_ON(flags
!= XATTR_REPLACE
);
1134 return ecryptfs_removexattr(dentry
, inode
, name
);
1138 const struct xattr_handler ecryptfs_xattr_handler
= {
1139 .prefix
= "", /* match anything */
1140 .get
= ecryptfs_xattr_get
,
1141 .set
= ecryptfs_xattr_set
,
1144 const struct xattr_handler
*ecryptfs_xattr_handlers
[] = {
1145 &ecryptfs_xattr_handler
,