2 * eCryptfs: Linux filesystem encryption layer
4 * Copyright (C) 1997-2004 Erez Zadok
5 * Copyright (C) 2001-2004 Stony Brook University
6 * Copyright (C) 2004-2007 International Business Machines Corp.
7 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8 * Michael C. Thompsion <mcthomps@us.ibm.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26 #include <linux/file.h>
27 #include <linux/vmalloc.h>
28 #include <linux/pagemap.h>
29 #include <linux/dcache.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/crypto.h>
33 #include <linux/fs_stack.h>
34 #include <asm/unaligned.h>
35 #include "ecryptfs_kernel.h"
37 static struct dentry
*lock_parent(struct dentry
*dentry
)
41 dir
= dget_parent(dentry
);
42 mutex_lock_nested(&(dir
->d_inode
->i_mutex
), I_MUTEX_PARENT
);
46 static void unlock_dir(struct dentry
*dir
)
48 mutex_unlock(&dir
->d_inode
->i_mutex
);
53 * ecryptfs_create_underlying_file
54 * @lower_dir_inode: inode of the parent in the lower fs of the new file
55 * @dentry: New file's dentry
56 * @mode: The mode of the new file
57 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
59 * Creates the file in the lower file system.
61 * Returns zero on success; non-zero on error condition
64 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
65 struct dentry
*dentry
, int mode
,
68 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
69 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
70 struct dentry
*dentry_save
;
71 struct vfsmount
*vfsmount_save
;
74 dentry_save
= nd
->path
.dentry
;
75 vfsmount_save
= nd
->path
.mnt
;
76 nd
->path
.dentry
= lower_dentry
;
77 nd
->path
.mnt
= lower_mnt
;
78 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
79 nd
->path
.dentry
= dentry_save
;
80 nd
->path
.mnt
= vfsmount_save
;
86 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
87 * @ecryptfs_dentry: New file's dentry in ecryptfs
88 * @mode: The mode of the new file
89 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
91 * Creates the underlying file and the eCryptfs inode which will link to
92 * it. It will also update the eCryptfs directory inode to mimic the
93 * stat of the lower directory inode.
95 * Returns zero on success; non-zero on error condition
98 ecryptfs_do_create(struct inode
*directory_inode
,
99 struct dentry
*ecryptfs_dentry
, int mode
,
100 struct nameidata
*nd
)
103 struct dentry
*lower_dentry
;
104 struct dentry
*lower_dir_dentry
;
106 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
107 lower_dir_dentry
= lock_parent(lower_dentry
);
108 if (IS_ERR(lower_dir_dentry
)) {
109 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
111 rc
= PTR_ERR(lower_dir_dentry
);
114 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
115 ecryptfs_dentry
, mode
, nd
);
117 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
118 "rc = [%d]\n", __func__
, rc
);
121 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
122 directory_inode
->i_sb
, 0);
124 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
127 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
128 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
130 unlock_dir(lower_dir_dentry
);
137 * @ecryptfs_dentry: the eCryptfs dentry
139 * This is the code which will grow the file to its correct size.
141 static int grow_file(struct dentry
*ecryptfs_dentry
)
143 struct inode
*ecryptfs_inode
= ecryptfs_dentry
->d_inode
;
144 struct file fake_file
;
145 struct ecryptfs_file_info tmp_file_info
;
146 char zero_virt
[] = { 0x00 };
149 memset(&fake_file
, 0, sizeof(fake_file
));
150 fake_file
.f_path
.dentry
= ecryptfs_dentry
;
151 memset(&tmp_file_info
, 0, sizeof(tmp_file_info
));
152 ecryptfs_set_file_private(&fake_file
, &tmp_file_info
);
153 ecryptfs_set_file_lower(
155 ecryptfs_inode_to_private(ecryptfs_inode
)->lower_file
);
156 rc
= ecryptfs_write(&fake_file
, zero_virt
, 0, 1);
157 i_size_write(ecryptfs_inode
, 0);
158 rc
= ecryptfs_write_inode_size_to_metadata(ecryptfs_inode
);
159 ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
.flags
|=
165 * ecryptfs_initialize_file
167 * Cause the file to be changed from a basic empty file to an ecryptfs
168 * file with a header and first data page.
170 * Returns zero on success
172 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
174 struct ecryptfs_crypt_stat
*crypt_stat
=
175 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
178 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
179 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
180 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
183 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
184 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
185 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
187 ecryptfs_printk(KERN_ERR
, "Error creating new file "
188 "context; rc = [%d]\n", rc
);
191 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
192 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
194 printk(KERN_ERR
"%s: Error attempting to initialize "
195 "the persistent file for the dentry with name "
196 "[%s]; rc = [%d]\n", __func__
,
197 ecryptfs_dentry
->d_name
.name
, rc
);
201 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
203 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
206 rc
= grow_file(ecryptfs_dentry
);
208 printk(KERN_ERR
"Error growing file; rc = [%d]\n", rc
);
215 * @dir: The inode of the directory in which to create the file.
216 * @dentry: The eCryptfs dentry
217 * @mode: The mode of the new file.
220 * Creates a new file.
222 * Returns zero on success; non-zero on error condition
225 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
226 int mode
, struct nameidata
*nd
)
230 /* ecryptfs_do_create() calls ecryptfs_interpose() */
231 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
233 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
234 "lower filesystem\n");
237 /* At this point, a file exists on "disk"; we need to make sure
238 * that this on disk file is prepared to be an ecryptfs file */
239 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
245 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
247 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
248 struct dentry
*lower_dentry
,
249 struct inode
*ecryptfs_dir_inode
,
250 struct nameidata
*ecryptfs_nd
)
252 struct dentry
*lower_dir_dentry
;
253 struct vfsmount
*lower_mnt
;
254 struct inode
*lower_inode
;
255 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
256 struct ecryptfs_crypt_stat
*crypt_stat
;
257 char *page_virt
= NULL
;
261 lower_dir_dentry
= lower_dentry
->d_parent
;
262 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
263 ecryptfs_dentry
->d_parent
));
264 lower_inode
= lower_dentry
->d_inode
;
265 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
266 BUG_ON(!atomic_read(&lower_dentry
->d_count
));
267 ecryptfs_set_dentry_private(ecryptfs_dentry
,
268 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
270 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
272 printk(KERN_ERR
"%s: Out of memory whilst attempting "
273 "to allocate ecryptfs_dentry_info struct\n",
277 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
278 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
279 if (!lower_dentry
->d_inode
) {
280 /* We want to add because we couldn't find in lower */
281 d_add(ecryptfs_dentry
, NULL
);
284 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
285 ecryptfs_dir_inode
->i_sb
,
286 ECRYPTFS_INTERPOSE_FLAG_D_ADD
);
288 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
292 if (S_ISDIR(lower_inode
->i_mode
))
294 if (S_ISLNK(lower_inode
->i_mode
))
296 if (special_file(lower_inode
->i_mode
))
300 /* Released in this function */
301 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
303 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
308 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
309 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
311 printk(KERN_ERR
"%s: Error attempting to initialize "
312 "the persistent file for the dentry with name "
313 "[%s]; rc = [%d]\n", __func__
,
314 ecryptfs_dentry
->d_name
.name
, rc
);
318 crypt_stat
= &ecryptfs_inode_to_private(
319 ecryptfs_dentry
->d_inode
)->crypt_stat
;
320 /* TODO: lock for crypt_stat comparison */
321 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
322 ecryptfs_set_default_sizes(crypt_stat
);
323 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
324 ecryptfs_dentry
->d_inode
);
326 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
332 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
334 mount_crypt_stat
= &ecryptfs_superblock_to_private(
335 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
336 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
337 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
338 file_size
= (crypt_stat
->num_header_bytes_at_front
339 + i_size_read(lower_dentry
->d_inode
));
341 file_size
= i_size_read(lower_dentry
->d_inode
);
343 file_size
= get_unaligned_be64(page_virt
);
345 i_size_write(ecryptfs_dentry
->d_inode
, (loff_t
)file_size
);
347 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
351 d_drop(ecryptfs_dentry
);
358 * @ecryptfs_dir_inode: The eCryptfs directory inode
359 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
360 * @ecryptfs_nd: nameidata; may be NULL
362 * Find a file on disk. If the file does not exist, then we'll add it to the
363 * dentry cache and continue on to read it from the disk.
365 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
366 struct dentry
*ecryptfs_dentry
,
367 struct nameidata
*ecryptfs_nd
)
369 char *encrypted_and_encoded_name
= NULL
;
370 size_t encrypted_and_encoded_name_size
;
371 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
372 struct dentry
*lower_dir_dentry
, *lower_dentry
;
375 ecryptfs_dentry
->d_op
= &ecryptfs_dops
;
376 if ((ecryptfs_dentry
->d_name
.len
== 1
377 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
378 || (ecryptfs_dentry
->d_name
.len
== 2
379 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
382 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
383 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
384 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
386 ecryptfs_dentry
->d_name
.len
);
387 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
388 if (IS_ERR(lower_dentry
)) {
389 rc
= PTR_ERR(lower_dentry
);
390 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
391 "lower_dentry = [%s]\n", __func__
, rc
,
392 ecryptfs_dentry
->d_name
.name
);
395 if (lower_dentry
->d_inode
)
396 goto lookup_and_interpose
;
397 mount_crypt_stat
= &ecryptfs_superblock_to_private(
398 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
399 if (!(mount_crypt_stat
400 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
401 goto lookup_and_interpose
;
403 rc
= ecryptfs_encrypt_and_encode_filename(
404 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
405 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
406 ecryptfs_dentry
->d_name
.len
);
408 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
409 "filename; rc = [%d]\n", __func__
, rc
);
412 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
413 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
415 encrypted_and_encoded_name_size
- 1);
416 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
417 if (IS_ERR(lower_dentry
)) {
418 rc
= PTR_ERR(lower_dentry
);
419 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
420 "lower_dentry = [%s]\n", __func__
, rc
,
421 encrypted_and_encoded_name
);
424 lookup_and_interpose
:
425 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
430 d_drop(ecryptfs_dentry
);
432 kfree(encrypted_and_encoded_name
);
436 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
437 struct dentry
*new_dentry
)
439 struct dentry
*lower_old_dentry
;
440 struct dentry
*lower_new_dentry
;
441 struct dentry
*lower_dir_dentry
;
445 file_size_save
= i_size_read(old_dentry
->d_inode
);
446 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
447 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
448 dget(lower_old_dentry
);
449 dget(lower_new_dentry
);
450 lower_dir_dentry
= lock_parent(lower_new_dentry
);
451 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
453 if (rc
|| !lower_new_dentry
->d_inode
)
455 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
458 fsstack_copy_attr_times(dir
, lower_new_dentry
->d_inode
);
459 fsstack_copy_inode_size(dir
, lower_new_dentry
->d_inode
);
460 old_dentry
->d_inode
->i_nlink
=
461 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
462 i_size_write(new_dentry
->d_inode
, file_size_save
);
464 unlock_dir(lower_dir_dentry
);
465 dput(lower_new_dentry
);
466 dput(lower_old_dentry
);
470 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
473 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
474 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
475 struct dentry
*lower_dir_dentry
;
478 lower_dir_dentry
= lock_parent(lower_dentry
);
479 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
481 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
484 fsstack_copy_attr_times(dir
, lower_dir_inode
);
485 dentry
->d_inode
->i_nlink
=
486 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
487 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
490 unlock_dir(lower_dir_dentry
);
495 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
499 struct dentry
*lower_dentry
;
500 struct dentry
*lower_dir_dentry
;
501 char *encoded_symname
;
502 size_t encoded_symlen
;
503 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
505 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
507 lower_dir_dentry
= lock_parent(lower_dentry
);
508 mount_crypt_stat
= &ecryptfs_superblock_to_private(
509 dir
->i_sb
)->mount_crypt_stat
;
510 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
513 mount_crypt_stat
, symname
,
517 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
519 kfree(encoded_symname
);
520 if (rc
|| !lower_dentry
->d_inode
)
522 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
525 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
526 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
528 unlock_dir(lower_dir_dentry
);
530 if (!dentry
->d_inode
)
535 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
538 struct dentry
*lower_dentry
;
539 struct dentry
*lower_dir_dentry
;
541 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
542 lower_dir_dentry
= lock_parent(lower_dentry
);
543 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
544 if (rc
|| !lower_dentry
->d_inode
)
546 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
549 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
550 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
551 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
553 unlock_dir(lower_dir_dentry
);
554 if (!dentry
->d_inode
)
559 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
561 struct dentry
*lower_dentry
;
562 struct dentry
*lower_dir_dentry
;
565 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
567 lower_dir_dentry
= lock_parent(lower_dentry
);
569 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
572 d_delete(lower_dentry
);
573 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
574 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
575 unlock_dir(lower_dir_dentry
);
583 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
586 struct dentry
*lower_dentry
;
587 struct dentry
*lower_dir_dentry
;
589 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
590 lower_dir_dentry
= lock_parent(lower_dentry
);
591 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
592 if (rc
|| !lower_dentry
->d_inode
)
594 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
597 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
598 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
600 unlock_dir(lower_dir_dentry
);
601 if (!dentry
->d_inode
)
607 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
608 struct inode
*new_dir
, struct dentry
*new_dentry
)
611 struct dentry
*lower_old_dentry
;
612 struct dentry
*lower_new_dentry
;
613 struct dentry
*lower_old_dir_dentry
;
614 struct dentry
*lower_new_dir_dentry
;
615 struct dentry
*trap
= NULL
;
617 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
618 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
619 dget(lower_old_dentry
);
620 dget(lower_new_dentry
);
621 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
622 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
623 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
624 /* source should not be ancestor of target */
625 if (trap
== lower_old_dentry
) {
629 /* target should not be ancestor of source */
630 if (trap
== lower_new_dentry
) {
634 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
635 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
638 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
639 if (new_dir
!= old_dir
)
640 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
642 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
643 dput(lower_new_dentry
->d_parent
);
644 dput(lower_old_dentry
->d_parent
);
645 dput(lower_new_dentry
);
646 dput(lower_old_dentry
);
650 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
653 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
655 size_t lower_bufsiz
= PATH_MAX
;
659 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
666 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
667 (char __user
*)lower_buf
,
673 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
674 lower_buf
, lower_bufsiz
);
681 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
684 size_t kbufsiz
, copied
;
687 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
690 copied
= min_t(size_t, bufsiz
, kbufsiz
);
691 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
693 fsstack_copy_attr_atime(dentry
->d_inode
,
694 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
699 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
702 int len
= PAGE_SIZE
, rc
;
705 /* Released in ecryptfs_put_link(); only release here on error */
706 buf
= kmalloc(len
, GFP_KERNEL
);
708 buf
= ERR_PTR(-ENOMEM
);
713 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
721 nd_set_link(nd
, buf
);
726 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
728 char *buf
= nd_get_link(nd
);
736 * upper_size_to_lower_size
737 * @crypt_stat: Crypt_stat associated with file
738 * @upper_size: Size of the upper file
740 * Calculate the required size of the lower file based on the
741 * specified size of the upper file. This calculation is based on the
742 * number of headers in the underlying file and the extent size.
744 * Returns Calculated size of the lower file.
747 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
752 lower_size
= crypt_stat
->num_header_bytes_at_front
;
753 if (upper_size
!= 0) {
756 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
757 if (upper_size
& ~crypt_stat
->extent_mask
)
759 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
766 * @dentry: The ecryptfs layer dentry
767 * @ia: Address of the ecryptfs inode's attributes
768 * @lower_ia: Address of the lower inode's attributes
770 * Function to handle truncations modifying the size of the file. Note
771 * that the file sizes are interpolated. When expanding, we are simply
772 * writing strings of 0's out. When truncating, we truncate the upper
773 * inode and update the lower_ia according to the page index
774 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
775 * the caller must use lower_ia in a call to notify_change() to perform
776 * the truncation of the lower inode.
778 * Returns zero on success; non-zero otherwise
780 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
781 struct iattr
*lower_ia
)
784 struct inode
*inode
= dentry
->d_inode
;
785 struct dentry
*lower_dentry
;
786 struct file fake_ecryptfs_file
;
787 struct ecryptfs_crypt_stat
*crypt_stat
;
788 loff_t i_size
= i_size_read(inode
);
789 loff_t lower_size_before_truncate
;
790 loff_t lower_size_after_truncate
;
792 if (unlikely((ia
->ia_size
== i_size
))) {
793 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
796 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
797 /* Set up a fake ecryptfs file, this is used to interface with
798 * the file in the underlying filesystem so that the
799 * truncation has an effect there as well. */
800 memset(&fake_ecryptfs_file
, 0, sizeof(fake_ecryptfs_file
));
801 fake_ecryptfs_file
.f_path
.dentry
= dentry
;
802 /* Released at out_free: label */
803 ecryptfs_set_file_private(&fake_ecryptfs_file
,
804 kmem_cache_alloc(ecryptfs_file_info_cache
,
806 if (unlikely(!ecryptfs_file_to_private(&fake_ecryptfs_file
))) {
810 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
811 ecryptfs_set_file_lower(
813 ecryptfs_inode_to_private(dentry
->d_inode
)->lower_file
);
814 /* Switch on growing or shrinking file */
815 if (ia
->ia_size
> i_size
) {
816 char zero
[] = { 0x00 };
818 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
819 /* Write a single 0 at the last position of the file;
820 * this triggers code that will fill in 0's throughout
821 * the intermediate portion of the previous end of the
822 * file and the new and of the file */
823 rc
= ecryptfs_write(&fake_ecryptfs_file
, zero
,
824 (ia
->ia_size
- 1), 1);
825 } else { /* ia->ia_size < i_size_read(inode) */
826 /* We're chopping off all the pages down to the page
827 * in which ia->ia_size is located. Fill in the end of
828 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
829 * PAGE_CACHE_SIZE with zeros. */
830 size_t num_zeros
= (PAGE_CACHE_SIZE
831 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
833 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
834 rc
= vmtruncate(inode
, ia
->ia_size
);
837 lower_ia
->ia_size
= ia
->ia_size
;
838 lower_ia
->ia_valid
|= ATTR_SIZE
;
844 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
849 rc
= ecryptfs_write(&fake_ecryptfs_file
, zeros_virt
,
850 ia
->ia_size
, num_zeros
);
853 printk(KERN_ERR
"Error attempting to zero out "
854 "the remainder of the end page on "
855 "reducing truncate; rc = [%d]\n", rc
);
859 vmtruncate(inode
, ia
->ia_size
);
860 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
862 printk(KERN_ERR
"Problem with "
863 "ecryptfs_write_inode_size_to_metadata; "
867 /* We are reducing the size of the ecryptfs file, and need to
868 * know if we need to reduce the size of the lower file. */
869 lower_size_before_truncate
=
870 upper_size_to_lower_size(crypt_stat
, i_size
);
871 lower_size_after_truncate
=
872 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
873 if (lower_size_after_truncate
< lower_size_before_truncate
) {
874 lower_ia
->ia_size
= lower_size_after_truncate
;
875 lower_ia
->ia_valid
|= ATTR_SIZE
;
877 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
880 if (ecryptfs_file_to_private(&fake_ecryptfs_file
))
881 kmem_cache_free(ecryptfs_file_info_cache
,
882 ecryptfs_file_to_private(&fake_ecryptfs_file
));
889 * @dentry: The ecryptfs layer dentry
890 * @new_length: The length to expand the file to
892 * Simple function that handles the truncation of an eCryptfs inode and
893 * its corresponding lower inode.
895 * Returns zero on success; non-zero otherwise
897 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
899 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
900 struct iattr lower_ia
= { .ia_valid
= 0 };
903 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
904 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
905 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
907 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
908 rc
= notify_change(lower_dentry
, &lower_ia
);
909 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
915 ecryptfs_permission(struct inode
*inode
, int mask
)
917 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
922 * @dentry: dentry handle to the inode to modify
923 * @ia: Structure with flags of what to change and values
925 * Updates the metadata of an inode. If the update is to the size
926 * i.e. truncation, then ecryptfs_truncate will handle the size modification
927 * of both the ecryptfs inode and the lower inode.
929 * All other metadata changes will be passed right to the lower filesystem,
930 * and we will just update our inode to look like the lower.
932 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
935 struct dentry
*lower_dentry
;
936 struct iattr lower_ia
;
938 struct inode
*lower_inode
;
939 struct ecryptfs_crypt_stat
*crypt_stat
;
941 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
942 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
943 ecryptfs_init_crypt_stat(crypt_stat
);
944 inode
= dentry
->d_inode
;
945 lower_inode
= ecryptfs_inode_to_lower(inode
);
946 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
947 mutex_lock(&crypt_stat
->cs_mutex
);
948 if (S_ISDIR(dentry
->d_inode
->i_mode
))
949 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
950 else if (S_ISREG(dentry
->d_inode
->i_mode
)
951 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
952 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
953 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
955 mount_crypt_stat
= &ecryptfs_superblock_to_private(
956 dentry
->d_sb
)->mount_crypt_stat
;
957 rc
= ecryptfs_read_metadata(dentry
);
959 if (!(mount_crypt_stat
->flags
960 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
962 printk(KERN_WARNING
"Either the lower file "
963 "is not in a valid eCryptfs format, "
964 "or the key could not be retrieved. "
965 "Plaintext passthrough mode is not "
966 "enabled; returning -EIO\n");
967 mutex_unlock(&crypt_stat
->cs_mutex
);
971 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
974 mutex_unlock(&crypt_stat
->cs_mutex
);
975 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
976 if (ia
->ia_valid
& ATTR_FILE
)
977 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
978 if (ia
->ia_valid
& ATTR_SIZE
) {
979 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
985 * mode change is for clearing setuid/setgid bits. Allow lower fs
986 * to interpret this in its own way.
988 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
989 lower_ia
.ia_valid
&= ~ATTR_MODE
;
991 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
992 rc
= notify_change(lower_dentry
, &lower_ia
);
993 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
995 fsstack_copy_attr_all(inode
, lower_inode
);
999 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
1002 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1005 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1006 dentry
->d_sb
)->mount_crypt_stat
;
1007 generic_fillattr(dentry
->d_inode
, stat
);
1008 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1012 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
1015 stat
->size
= targetsiz
;
1021 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1024 struct kstat lower_stat
;
1027 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
1028 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
1030 generic_fillattr(dentry
->d_inode
, stat
);
1031 stat
->blocks
= lower_stat
.blocks
;
1037 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1038 size_t size
, int flags
)
1041 struct dentry
*lower_dentry
;
1043 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1044 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1048 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1049 rc
= lower_dentry
->d_inode
->i_op
->setxattr(lower_dentry
, name
, value
,
1051 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1057 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1058 void *value
, size_t size
)
1062 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1066 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1067 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1069 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1075 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1078 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1083 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1086 struct dentry
*lower_dentry
;
1088 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1089 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1093 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1094 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1095 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1100 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1103 struct dentry
*lower_dentry
;
1105 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1106 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1110 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1111 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1112 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1117 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1119 if ((ecryptfs_inode_to_lower(inode
)
1120 == (struct inode
*)candidate_lower_inode
))
1126 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1128 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1132 const struct inode_operations ecryptfs_symlink_iops
= {
1133 .readlink
= ecryptfs_readlink
,
1134 .follow_link
= ecryptfs_follow_link
,
1135 .put_link
= ecryptfs_put_link
,
1136 .permission
= ecryptfs_permission
,
1137 .setattr
= ecryptfs_setattr
,
1138 .getattr
= ecryptfs_getattr_link
,
1139 .setxattr
= ecryptfs_setxattr
,
1140 .getxattr
= ecryptfs_getxattr
,
1141 .listxattr
= ecryptfs_listxattr
,
1142 .removexattr
= ecryptfs_removexattr
1145 const struct inode_operations ecryptfs_dir_iops
= {
1146 .create
= ecryptfs_create
,
1147 .lookup
= ecryptfs_lookup
,
1148 .link
= ecryptfs_link
,
1149 .unlink
= ecryptfs_unlink
,
1150 .symlink
= ecryptfs_symlink
,
1151 .mkdir
= ecryptfs_mkdir
,
1152 .rmdir
= ecryptfs_rmdir
,
1153 .mknod
= ecryptfs_mknod
,
1154 .rename
= ecryptfs_rename
,
1155 .permission
= ecryptfs_permission
,
1156 .setattr
= ecryptfs_setattr
,
1157 .setxattr
= ecryptfs_setxattr
,
1158 .getxattr
= ecryptfs_getxattr
,
1159 .listxattr
= ecryptfs_listxattr
,
1160 .removexattr
= ecryptfs_removexattr
1163 const struct inode_operations ecryptfs_main_iops
= {
1164 .permission
= ecryptfs_permission
,
1165 .setattr
= ecryptfs_setattr
,
1166 .getattr
= ecryptfs_getattr
,
1167 .setxattr
= ecryptfs_setxattr
,
1168 .getxattr
= ecryptfs_getxattr
,
1169 .listxattr
= ecryptfs_listxattr
,
1170 .removexattr
= ecryptfs_removexattr