2 * eCryptfs: Linux filesystem encryption layer
4 * Copyright (C) 1997-2004 Erez Zadok
5 * Copyright (C) 2001-2004 Stony Brook University
6 * Copyright (C) 2004-2007 International Business Machines Corp.
7 * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
8 * Michael C. Thompsion <mcthomps@us.ibm.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
26 #include <linux/file.h>
27 #include <linux/vmalloc.h>
28 #include <linux/pagemap.h>
29 #include <linux/dcache.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/crypto.h>
33 #include <linux/fs_stack.h>
34 #include <linux/slab.h>
35 #include <linux/xattr.h>
36 #include <asm/unaligned.h>
37 #include "ecryptfs_kernel.h"
39 static struct dentry
*lock_parent(struct dentry
*dentry
)
43 dir
= dget_parent(dentry
);
44 mutex_lock_nested(&(dir
->d_inode
->i_mutex
), I_MUTEX_PARENT
);
48 static void unlock_dir(struct dentry
*dir
)
50 mutex_unlock(&dir
->d_inode
->i_mutex
);
55 * ecryptfs_create_underlying_file
56 * @lower_dir_inode: inode of the parent in the lower fs of the new file
57 * @dentry: New file's dentry
58 * @mode: The mode of the new file
59 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
61 * Creates the file in the lower file system.
63 * Returns zero on success; non-zero on error condition
66 ecryptfs_create_underlying_file(struct inode
*lower_dir_inode
,
67 struct dentry
*dentry
, int mode
,
70 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
71 struct vfsmount
*lower_mnt
= ecryptfs_dentry_to_lower_mnt(dentry
);
72 struct dentry
*dentry_save
;
73 struct vfsmount
*vfsmount_save
;
74 unsigned int flags_save
;
77 dentry_save
= nd
->path
.dentry
;
78 vfsmount_save
= nd
->path
.mnt
;
79 flags_save
= nd
->flags
;
80 nd
->path
.dentry
= lower_dentry
;
81 nd
->path
.mnt
= lower_mnt
;
82 nd
->flags
&= ~LOOKUP_OPEN
;
83 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
84 nd
->path
.dentry
= dentry_save
;
85 nd
->path
.mnt
= vfsmount_save
;
86 nd
->flags
= flags_save
;
92 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
93 * @ecryptfs_dentry: New file's dentry in ecryptfs
94 * @mode: The mode of the new file
95 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
97 * Creates the underlying file and the eCryptfs inode which will link to
98 * it. It will also update the eCryptfs directory inode to mimic the
99 * stat of the lower directory inode.
101 * Returns zero on success; non-zero on error condition
104 ecryptfs_do_create(struct inode
*directory_inode
,
105 struct dentry
*ecryptfs_dentry
, int mode
,
106 struct nameidata
*nd
)
109 struct dentry
*lower_dentry
;
110 struct dentry
*lower_dir_dentry
;
112 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
113 lower_dir_dentry
= lock_parent(lower_dentry
);
114 if (IS_ERR(lower_dir_dentry
)) {
115 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
117 rc
= PTR_ERR(lower_dir_dentry
);
120 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
121 ecryptfs_dentry
, mode
, nd
);
123 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
124 "rc = [%d]\n", __func__
, rc
);
127 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
128 directory_inode
->i_sb
, 0);
130 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
133 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
134 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
136 unlock_dir(lower_dir_dentry
);
143 * @ecryptfs_dentry: the eCryptfs dentry
145 * This is the code which will grow the file to its correct size.
147 static int grow_file(struct dentry
*ecryptfs_dentry
)
149 struct inode
*ecryptfs_inode
= ecryptfs_dentry
->d_inode
;
150 char zero_virt
[] = { 0x00 };
153 rc
= ecryptfs_write(ecryptfs_inode
, zero_virt
, 0, 1);
154 i_size_write(ecryptfs_inode
, 0);
155 rc
= ecryptfs_write_inode_size_to_metadata(ecryptfs_inode
);
156 ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
.flags
|=
162 * ecryptfs_initialize_file
164 * Cause the file to be changed from a basic empty file to an ecryptfs
165 * file with a header and first data page.
167 * Returns zero on success
169 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
171 struct ecryptfs_crypt_stat
*crypt_stat
=
172 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
175 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
176 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
177 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
180 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
181 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
182 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
184 ecryptfs_printk(KERN_ERR
, "Error creating new file "
185 "context; rc = [%d]\n", rc
);
188 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
190 printk(KERN_ERR
"%s: Error attempting to initialize "
191 "the persistent file for the dentry with name "
192 "[%s]; rc = [%d]\n", __func__
,
193 ecryptfs_dentry
->d_name
.name
, rc
);
196 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
198 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
201 rc
= grow_file(ecryptfs_dentry
);
203 printk(KERN_ERR
"Error growing file; rc = [%d]\n", rc
);
210 * @dir: The inode of the directory in which to create the file.
211 * @dentry: The eCryptfs dentry
212 * @mode: The mode of the new file.
215 * Creates a new file.
217 * Returns zero on success; non-zero on error condition
220 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
221 int mode
, struct nameidata
*nd
)
225 /* ecryptfs_do_create() calls ecryptfs_interpose() */
226 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
228 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
229 "lower filesystem\n");
232 /* At this point, a file exists on "disk"; we need to make sure
233 * that this on disk file is prepared to be an ecryptfs file */
234 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
240 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
242 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
243 struct dentry
*lower_dentry
,
244 struct inode
*ecryptfs_dir_inode
,
245 struct nameidata
*ecryptfs_nd
)
247 struct dentry
*lower_dir_dentry
;
248 struct vfsmount
*lower_mnt
;
249 struct inode
*lower_inode
;
250 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
251 struct ecryptfs_crypt_stat
*crypt_stat
;
252 char *page_virt
= NULL
;
256 lower_dir_dentry
= lower_dentry
->d_parent
;
257 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
258 ecryptfs_dentry
->d_parent
));
259 lower_inode
= lower_dentry
->d_inode
;
260 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
261 BUG_ON(!lower_dentry
->d_count
);
262 ecryptfs_set_dentry_private(ecryptfs_dentry
,
263 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
265 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
267 printk(KERN_ERR
"%s: Out of memory whilst attempting "
268 "to allocate ecryptfs_dentry_info struct\n",
272 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
273 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
274 if (!lower_dentry
->d_inode
) {
275 /* We want to add because we couldn't find in lower */
276 d_add(ecryptfs_dentry
, NULL
);
279 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
280 ecryptfs_dir_inode
->i_sb
,
281 ECRYPTFS_INTERPOSE_FLAG_D_ADD
);
283 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
287 if (S_ISDIR(lower_inode
->i_mode
))
289 if (S_ISLNK(lower_inode
->i_mode
))
291 if (special_file(lower_inode
->i_mode
))
295 /* Released in this function */
296 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
298 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
303 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
305 printk(KERN_ERR
"%s: Error attempting to initialize "
306 "the persistent file for the dentry with name "
307 "[%s]; rc = [%d]\n", __func__
,
308 ecryptfs_dentry
->d_name
.name
, rc
);
311 crypt_stat
= &ecryptfs_inode_to_private(
312 ecryptfs_dentry
->d_inode
)->crypt_stat
;
313 /* TODO: lock for crypt_stat comparison */
314 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
315 ecryptfs_set_default_sizes(crypt_stat
);
316 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
317 ecryptfs_dentry
->d_inode
);
319 memset(page_virt
, 0, PAGE_CACHE_SIZE
);
320 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
326 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
328 mount_crypt_stat
= &ecryptfs_superblock_to_private(
329 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
330 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
331 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
332 file_size
= (crypt_stat
->metadata_size
333 + i_size_read(lower_dentry
->d_inode
));
335 file_size
= i_size_read(lower_dentry
->d_inode
);
337 file_size
= get_unaligned_be64(page_virt
);
339 i_size_write(ecryptfs_dentry
->d_inode
, (loff_t
)file_size
);
341 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
346 d_drop(ecryptfs_dentry
);
352 * ecryptfs_new_lower_dentry
353 * @name: The name of the new dentry.
354 * @lower_dir_dentry: Parent directory of the new dentry.
355 * @nd: nameidata from last lookup.
357 * Create a new dentry or get it from lower parent dir.
359 static struct dentry
*
360 ecryptfs_new_lower_dentry(struct qstr
*name
, struct dentry
*lower_dir_dentry
,
361 struct nameidata
*nd
)
363 struct dentry
*new_dentry
;
365 struct inode
*lower_dir_inode
;
367 lower_dir_inode
= lower_dir_dentry
->d_inode
;
369 tmp
= d_alloc(lower_dir_dentry
, name
);
371 return ERR_PTR(-ENOMEM
);
373 mutex_lock(&lower_dir_inode
->i_mutex
);
374 new_dentry
= lower_dir_inode
->i_op
->lookup(lower_dir_inode
, tmp
, nd
);
375 mutex_unlock(&lower_dir_inode
->i_mutex
);
387 * ecryptfs_lookup_one_lower
388 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
389 * @lower_dir_dentry: lower parent directory
390 * @name: lower file name
392 * Get the lower dentry from vfs. If lower dentry does not exist yet,
395 static struct dentry
*
396 ecryptfs_lookup_one_lower(struct dentry
*ecryptfs_dentry
,
397 struct dentry
*lower_dir_dentry
, struct qstr
*name
)
400 struct vfsmount
*lower_mnt
;
403 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
404 ecryptfs_dentry
->d_parent
));
405 err
= vfs_path_lookup(lower_dir_dentry
, lower_mnt
, name
->name
, 0, &nd
);
409 /* we dont need the mount */
411 return nd
.path
.dentry
;
416 /* create a new lower dentry */
417 return ecryptfs_new_lower_dentry(name
, lower_dir_dentry
, &nd
);
422 * @ecryptfs_dir_inode: The eCryptfs directory inode
423 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
424 * @ecryptfs_nd: nameidata; may be NULL
426 * Find a file on disk. If the file does not exist, then we'll add it to the
427 * dentry cache and continue on to read it from the disk.
429 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
430 struct dentry
*ecryptfs_dentry
,
431 struct nameidata
*ecryptfs_nd
)
433 char *encrypted_and_encoded_name
= NULL
;
434 size_t encrypted_and_encoded_name_size
;
435 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
436 struct dentry
*lower_dir_dentry
, *lower_dentry
;
437 struct qstr lower_name
;
440 if ((ecryptfs_dentry
->d_name
.len
== 1
441 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
442 || (ecryptfs_dentry
->d_name
.len
== 2
443 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
446 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
447 lower_name
.name
= ecryptfs_dentry
->d_name
.name
;
448 lower_name
.len
= ecryptfs_dentry
->d_name
.len
;
449 lower_name
.hash
= ecryptfs_dentry
->d_name
.hash
;
450 if (lower_dir_dentry
->d_op
&& lower_dir_dentry
->d_op
->d_hash
) {
451 rc
= lower_dir_dentry
->d_op
->d_hash(lower_dir_dentry
,
452 lower_dir_dentry
->d_inode
, &lower_name
);
456 lower_dentry
= ecryptfs_lookup_one_lower(ecryptfs_dentry
,
457 lower_dir_dentry
, &lower_name
);
458 if (IS_ERR(lower_dentry
)) {
459 rc
= PTR_ERR(lower_dentry
);
460 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_lower() returned "
461 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
462 encrypted_and_encoded_name
);
465 if (lower_dentry
->d_inode
)
466 goto lookup_and_interpose
;
467 mount_crypt_stat
= &ecryptfs_superblock_to_private(
468 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
469 if (!(mount_crypt_stat
470 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
471 goto lookup_and_interpose
;
473 rc
= ecryptfs_encrypt_and_encode_filename(
474 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
475 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
476 ecryptfs_dentry
->d_name
.len
);
478 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
479 "filename; rc = [%d]\n", __func__
, rc
);
482 lower_name
.name
= encrypted_and_encoded_name
;
483 lower_name
.len
= encrypted_and_encoded_name_size
;
484 lower_name
.hash
= full_name_hash(lower_name
.name
, lower_name
.len
);
485 if (lower_dir_dentry
->d_op
&& lower_dir_dentry
->d_op
->d_hash
) {
486 rc
= lower_dir_dentry
->d_op
->d_hash(lower_dir_dentry
,
487 lower_dir_dentry
->d_inode
, &lower_name
);
491 lower_dentry
= ecryptfs_lookup_one_lower(ecryptfs_dentry
,
492 lower_dir_dentry
, &lower_name
);
493 if (IS_ERR(lower_dentry
)) {
494 rc
= PTR_ERR(lower_dentry
);
495 ecryptfs_printk(KERN_DEBUG
, "%s: lookup_one_lower() returned "
496 "[%d] on lower_dentry = [%s]\n", __func__
, rc
,
497 encrypted_and_encoded_name
);
500 lookup_and_interpose
:
501 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
506 d_drop(ecryptfs_dentry
);
508 kfree(encrypted_and_encoded_name
);
512 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
513 struct dentry
*new_dentry
)
515 struct dentry
*lower_old_dentry
;
516 struct dentry
*lower_new_dentry
;
517 struct dentry
*lower_dir_dentry
;
521 file_size_save
= i_size_read(old_dentry
->d_inode
);
522 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
523 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
524 dget(lower_old_dentry
);
525 dget(lower_new_dentry
);
526 lower_dir_dentry
= lock_parent(lower_new_dentry
);
527 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
529 if (rc
|| !lower_new_dentry
->d_inode
)
531 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
534 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
535 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
536 old_dentry
->d_inode
->i_nlink
=
537 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
538 i_size_write(new_dentry
->d_inode
, file_size_save
);
540 unlock_dir(lower_dir_dentry
);
541 dput(lower_new_dentry
);
542 dput(lower_old_dentry
);
546 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
549 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
550 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
551 struct dentry
*lower_dir_dentry
;
554 lower_dir_dentry
= lock_parent(lower_dentry
);
555 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
557 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
560 fsstack_copy_attr_times(dir
, lower_dir_inode
);
561 dentry
->d_inode
->i_nlink
=
562 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
563 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
566 unlock_dir(lower_dir_dentry
);
571 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
575 struct dentry
*lower_dentry
;
576 struct dentry
*lower_dir_dentry
;
577 char *encoded_symname
;
578 size_t encoded_symlen
;
579 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
581 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
583 lower_dir_dentry
= lock_parent(lower_dentry
);
584 mount_crypt_stat
= &ecryptfs_superblock_to_private(
585 dir
->i_sb
)->mount_crypt_stat
;
586 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
589 mount_crypt_stat
, symname
,
593 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
595 kfree(encoded_symname
);
596 if (rc
|| !lower_dentry
->d_inode
)
598 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
601 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
602 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
604 unlock_dir(lower_dir_dentry
);
606 if (!dentry
->d_inode
)
611 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
614 struct dentry
*lower_dentry
;
615 struct dentry
*lower_dir_dentry
;
617 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
618 lower_dir_dentry
= lock_parent(lower_dentry
);
619 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
620 if (rc
|| !lower_dentry
->d_inode
)
622 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
625 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
626 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
627 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
629 unlock_dir(lower_dir_dentry
);
630 if (!dentry
->d_inode
)
635 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
637 struct dentry
*lower_dentry
;
638 struct dentry
*lower_dir_dentry
;
641 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
643 lower_dir_dentry
= lock_parent(lower_dentry
);
645 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
648 d_delete(lower_dentry
);
649 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
650 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
651 unlock_dir(lower_dir_dentry
);
659 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
662 struct dentry
*lower_dentry
;
663 struct dentry
*lower_dir_dentry
;
665 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
666 lower_dir_dentry
= lock_parent(lower_dentry
);
667 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
668 if (rc
|| !lower_dentry
->d_inode
)
670 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
673 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
674 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
676 unlock_dir(lower_dir_dentry
);
677 if (!dentry
->d_inode
)
683 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
684 struct inode
*new_dir
, struct dentry
*new_dentry
)
687 struct dentry
*lower_old_dentry
;
688 struct dentry
*lower_new_dentry
;
689 struct dentry
*lower_old_dir_dentry
;
690 struct dentry
*lower_new_dir_dentry
;
691 struct dentry
*trap
= NULL
;
693 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
694 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
695 dget(lower_old_dentry
);
696 dget(lower_new_dentry
);
697 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
698 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
699 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
700 /* source should not be ancestor of target */
701 if (trap
== lower_old_dentry
) {
705 /* target should not be ancestor of source */
706 if (trap
== lower_new_dentry
) {
710 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
711 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
714 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
715 if (new_dir
!= old_dir
)
716 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
718 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
719 dput(lower_new_dentry
->d_parent
);
720 dput(lower_old_dentry
->d_parent
);
721 dput(lower_new_dentry
);
722 dput(lower_old_dentry
);
726 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
729 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
731 size_t lower_bufsiz
= PATH_MAX
;
735 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
742 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
743 (char __user
*)lower_buf
,
749 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
750 lower_buf
, lower_bufsiz
);
757 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
760 size_t kbufsiz
, copied
;
763 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
766 copied
= min_t(size_t, bufsiz
, kbufsiz
);
767 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
769 fsstack_copy_attr_atime(dentry
->d_inode
,
770 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
775 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
778 int len
= PAGE_SIZE
, rc
;
781 /* Released in ecryptfs_put_link(); only release here on error */
782 buf
= kmalloc(len
, GFP_KERNEL
);
784 buf
= ERR_PTR(-ENOMEM
);
789 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
797 nd_set_link(nd
, buf
);
802 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
804 char *buf
= nd_get_link(nd
);
812 * upper_size_to_lower_size
813 * @crypt_stat: Crypt_stat associated with file
814 * @upper_size: Size of the upper file
816 * Calculate the required size of the lower file based on the
817 * specified size of the upper file. This calculation is based on the
818 * number of headers in the underlying file and the extent size.
820 * Returns Calculated size of the lower file.
823 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
828 lower_size
= ecryptfs_lower_header_size(crypt_stat
);
829 if (upper_size
!= 0) {
832 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
833 if (upper_size
& ~crypt_stat
->extent_mask
)
835 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
842 * @dentry: The ecryptfs layer dentry
843 * @ia: Address of the ecryptfs inode's attributes
844 * @lower_ia: Address of the lower inode's attributes
846 * Function to handle truncations modifying the size of the file. Note
847 * that the file sizes are interpolated. When expanding, we are simply
848 * writing strings of 0's out. When truncating, we truncate the upper
849 * inode and update the lower_ia according to the page index
850 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
851 * the caller must use lower_ia in a call to notify_change() to perform
852 * the truncation of the lower inode.
854 * Returns zero on success; non-zero otherwise
856 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
857 struct iattr
*lower_ia
)
860 struct inode
*inode
= dentry
->d_inode
;
861 struct ecryptfs_crypt_stat
*crypt_stat
;
862 loff_t i_size
= i_size_read(inode
);
863 loff_t lower_size_before_truncate
;
864 loff_t lower_size_after_truncate
;
866 if (unlikely((ia
->ia_size
== i_size
))) {
867 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
870 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
871 /* Switch on growing or shrinking file */
872 if (ia
->ia_size
> i_size
) {
873 char zero
[] = { 0x00 };
875 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
876 /* Write a single 0 at the last position of the file;
877 * this triggers code that will fill in 0's throughout
878 * the intermediate portion of the previous end of the
879 * file and the new and of the file */
880 rc
= ecryptfs_write(inode
, zero
,
881 (ia
->ia_size
- 1), 1);
882 } else { /* ia->ia_size < i_size_read(inode) */
883 /* We're chopping off all the pages down to the page
884 * in which ia->ia_size is located. Fill in the end of
885 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
886 * PAGE_CACHE_SIZE with zeros. */
887 size_t num_zeros
= (PAGE_CACHE_SIZE
888 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
892 * XXX(truncate) this should really happen at the begginning
893 * of ->setattr. But the code is too messy to that as part
894 * of a larger patch. ecryptfs is also totally missing out
895 * on the inode_change_ok check at the beginning of
896 * ->setattr while would include this.
898 rc
= inode_newsize_ok(inode
, ia
->ia_size
);
902 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
903 truncate_setsize(inode
, ia
->ia_size
);
904 lower_ia
->ia_size
= ia
->ia_size
;
905 lower_ia
->ia_valid
|= ATTR_SIZE
;
911 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
916 rc
= ecryptfs_write(inode
, zeros_virt
,
917 ia
->ia_size
, num_zeros
);
920 printk(KERN_ERR
"Error attempting to zero out "
921 "the remainder of the end page on "
922 "reducing truncate; rc = [%d]\n", rc
);
926 truncate_setsize(inode
, ia
->ia_size
);
927 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
929 printk(KERN_ERR
"Problem with "
930 "ecryptfs_write_inode_size_to_metadata; "
934 /* We are reducing the size of the ecryptfs file, and need to
935 * know if we need to reduce the size of the lower file. */
936 lower_size_before_truncate
=
937 upper_size_to_lower_size(crypt_stat
, i_size
);
938 lower_size_after_truncate
=
939 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
940 if (lower_size_after_truncate
< lower_size_before_truncate
) {
941 lower_ia
->ia_size
= lower_size_after_truncate
;
942 lower_ia
->ia_valid
|= ATTR_SIZE
;
944 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
952 * @dentry: The ecryptfs layer dentry
953 * @new_length: The length to expand the file to
955 * Simple function that handles the truncation of an eCryptfs inode and
956 * its corresponding lower inode.
958 * Returns zero on success; non-zero otherwise
960 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
962 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
963 struct iattr lower_ia
= { .ia_valid
= 0 };
966 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
967 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
968 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
970 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
971 rc
= notify_change(lower_dentry
, &lower_ia
);
972 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
978 ecryptfs_permission(struct inode
*inode
, int mask
, unsigned int flags
)
980 if (flags
& IPERM_FLAG_RCU
)
982 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
987 * @dentry: dentry handle to the inode to modify
988 * @ia: Structure with flags of what to change and values
990 * Updates the metadata of an inode. If the update is to the size
991 * i.e. truncation, then ecryptfs_truncate will handle the size modification
992 * of both the ecryptfs inode and the lower inode.
994 * All other metadata changes will be passed right to the lower filesystem,
995 * and we will just update our inode to look like the lower.
997 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
1000 struct dentry
*lower_dentry
;
1001 struct iattr lower_ia
;
1002 struct inode
*inode
;
1003 struct inode
*lower_inode
;
1004 struct ecryptfs_crypt_stat
*crypt_stat
;
1006 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
1007 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
1008 ecryptfs_init_crypt_stat(crypt_stat
);
1009 inode
= dentry
->d_inode
;
1010 lower_inode
= ecryptfs_inode_to_lower(inode
);
1011 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1012 mutex_lock(&crypt_stat
->cs_mutex
);
1013 if (S_ISDIR(dentry
->d_inode
->i_mode
))
1014 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
1015 else if (S_ISREG(dentry
->d_inode
->i_mode
)
1016 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
1017 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
1018 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1020 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1021 dentry
->d_sb
)->mount_crypt_stat
;
1022 rc
= ecryptfs_read_metadata(dentry
);
1024 if (!(mount_crypt_stat
->flags
1025 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
1027 printk(KERN_WARNING
"Either the lower file "
1028 "is not in a valid eCryptfs format, "
1029 "or the key could not be retrieved. "
1030 "Plaintext passthrough mode is not "
1031 "enabled; returning -EIO\n");
1032 mutex_unlock(&crypt_stat
->cs_mutex
);
1036 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
1039 mutex_unlock(&crypt_stat
->cs_mutex
);
1040 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
1041 if (ia
->ia_valid
& ATTR_FILE
)
1042 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
1043 if (ia
->ia_valid
& ATTR_SIZE
) {
1044 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
1050 * mode change is for clearing setuid/setgid bits. Allow lower fs
1051 * to interpret this in its own way.
1053 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
1054 lower_ia
.ia_valid
&= ~ATTR_MODE
;
1056 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1057 rc
= notify_change(lower_dentry
, &lower_ia
);
1058 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1060 fsstack_copy_attr_all(inode
, lower_inode
);
1064 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
1067 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1070 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1071 dentry
->d_sb
)->mount_crypt_stat
;
1072 generic_fillattr(dentry
->d_inode
, stat
);
1073 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1077 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
1080 stat
->size
= targetsiz
;
1086 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1089 struct kstat lower_stat
;
1092 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
1093 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
1095 generic_fillattr(dentry
->d_inode
, stat
);
1096 stat
->blocks
= lower_stat
.blocks
;
1102 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1103 size_t size
, int flags
)
1106 struct dentry
*lower_dentry
;
1108 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1109 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1114 rc
= vfs_setxattr(lower_dentry
, name
, value
, size
, flags
);
1120 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1121 void *value
, size_t size
)
1125 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1129 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1130 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1132 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1138 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1141 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1146 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1149 struct dentry
*lower_dentry
;
1151 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1152 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1156 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1157 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1158 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1163 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1166 struct dentry
*lower_dentry
;
1168 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1169 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1173 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1174 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1175 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1180 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1182 if ((ecryptfs_inode_to_lower(inode
)
1183 == (struct inode
*)candidate_lower_inode
))
1189 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1191 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1195 const struct inode_operations ecryptfs_symlink_iops
= {
1196 .readlink
= ecryptfs_readlink
,
1197 .follow_link
= ecryptfs_follow_link
,
1198 .put_link
= ecryptfs_put_link
,
1199 .permission
= ecryptfs_permission
,
1200 .setattr
= ecryptfs_setattr
,
1201 .getattr
= ecryptfs_getattr_link
,
1202 .setxattr
= ecryptfs_setxattr
,
1203 .getxattr
= ecryptfs_getxattr
,
1204 .listxattr
= ecryptfs_listxattr
,
1205 .removexattr
= ecryptfs_removexattr
1208 const struct inode_operations ecryptfs_dir_iops
= {
1209 .create
= ecryptfs_create
,
1210 .lookup
= ecryptfs_lookup
,
1211 .link
= ecryptfs_link
,
1212 .unlink
= ecryptfs_unlink
,
1213 .symlink
= ecryptfs_symlink
,
1214 .mkdir
= ecryptfs_mkdir
,
1215 .rmdir
= ecryptfs_rmdir
,
1216 .mknod
= ecryptfs_mknod
,
1217 .rename
= ecryptfs_rename
,
1218 .permission
= ecryptfs_permission
,
1219 .setattr
= ecryptfs_setattr
,
1220 .setxattr
= ecryptfs_setxattr
,
1221 .getxattr
= ecryptfs_getxattr
,
1222 .listxattr
= ecryptfs_listxattr
,
1223 .removexattr
= ecryptfs_removexattr
1226 const struct inode_operations ecryptfs_main_iops
= {
1227 .permission
= ecryptfs_permission
,
1228 .setattr
= ecryptfs_setattr
,
1229 .getattr
= ecryptfs_getattr
,
1230 .setxattr
= ecryptfs_setxattr
,
1231 .getxattr
= ecryptfs_getxattr
,
1232 .listxattr
= ecryptfs_listxattr
,
1233 .removexattr
= ecryptfs_removexattr