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
;
72 unsigned int flags_save
;
75 dentry_save
= nd
->path
.dentry
;
76 vfsmount_save
= nd
->path
.mnt
;
77 flags_save
= nd
->flags
;
78 nd
->path
.dentry
= lower_dentry
;
79 nd
->path
.mnt
= lower_mnt
;
80 nd
->flags
&= ~LOOKUP_OPEN
;
81 rc
= vfs_create(lower_dir_inode
, lower_dentry
, mode
, nd
);
82 nd
->path
.dentry
= dentry_save
;
83 nd
->path
.mnt
= vfsmount_save
;
84 nd
->flags
= flags_save
;
90 * @directory_inode: inode of the new file's dentry's parent in ecryptfs
91 * @ecryptfs_dentry: New file's dentry in ecryptfs
92 * @mode: The mode of the new file
93 * @nd: nameidata of ecryptfs' parent's dentry & vfsmount
95 * Creates the underlying file and the eCryptfs inode which will link to
96 * it. It will also update the eCryptfs directory inode to mimic the
97 * stat of the lower directory inode.
99 * Returns zero on success; non-zero on error condition
102 ecryptfs_do_create(struct inode
*directory_inode
,
103 struct dentry
*ecryptfs_dentry
, int mode
,
104 struct nameidata
*nd
)
107 struct dentry
*lower_dentry
;
108 struct dentry
*lower_dir_dentry
;
110 lower_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
);
111 lower_dir_dentry
= lock_parent(lower_dentry
);
112 if (IS_ERR(lower_dir_dentry
)) {
113 ecryptfs_printk(KERN_ERR
, "Error locking directory of "
115 rc
= PTR_ERR(lower_dir_dentry
);
118 rc
= ecryptfs_create_underlying_file(lower_dir_dentry
->d_inode
,
119 ecryptfs_dentry
, mode
, nd
);
121 printk(KERN_ERR
"%s: Failure to create dentry in lower fs; "
122 "rc = [%d]\n", __func__
, rc
);
125 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
126 directory_inode
->i_sb
, 0);
128 ecryptfs_printk(KERN_ERR
, "Failure in ecryptfs_interpose\n");
131 fsstack_copy_attr_times(directory_inode
, lower_dir_dentry
->d_inode
);
132 fsstack_copy_inode_size(directory_inode
, lower_dir_dentry
->d_inode
);
134 unlock_dir(lower_dir_dentry
);
141 * @ecryptfs_dentry: the eCryptfs dentry
143 * This is the code which will grow the file to its correct size.
145 static int grow_file(struct dentry
*ecryptfs_dentry
)
147 struct inode
*ecryptfs_inode
= ecryptfs_dentry
->d_inode
;
148 struct file fake_file
;
149 struct ecryptfs_file_info tmp_file_info
;
150 char zero_virt
[] = { 0x00 };
153 memset(&fake_file
, 0, sizeof(fake_file
));
154 fake_file
.f_path
.dentry
= ecryptfs_dentry
;
155 memset(&tmp_file_info
, 0, sizeof(tmp_file_info
));
156 ecryptfs_set_file_private(&fake_file
, &tmp_file_info
);
157 ecryptfs_set_file_lower(
159 ecryptfs_inode_to_private(ecryptfs_inode
)->lower_file
);
160 rc
= ecryptfs_write(&fake_file
, zero_virt
, 0, 1);
161 i_size_write(ecryptfs_inode
, 0);
162 rc
= ecryptfs_write_inode_size_to_metadata(ecryptfs_inode
);
163 ecryptfs_inode_to_private(ecryptfs_inode
)->crypt_stat
.flags
|=
169 * ecryptfs_initialize_file
171 * Cause the file to be changed from a basic empty file to an ecryptfs
172 * file with a header and first data page.
174 * Returns zero on success
176 static int ecryptfs_initialize_file(struct dentry
*ecryptfs_dentry
)
178 struct ecryptfs_crypt_stat
*crypt_stat
=
179 &ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->crypt_stat
;
182 if (S_ISDIR(ecryptfs_dentry
->d_inode
->i_mode
)) {
183 ecryptfs_printk(KERN_DEBUG
, "This is a directory\n");
184 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
187 crypt_stat
->flags
|= ECRYPTFS_NEW_FILE
;
188 ecryptfs_printk(KERN_DEBUG
, "Initializing crypto context\n");
189 rc
= ecryptfs_new_file_context(ecryptfs_dentry
);
191 ecryptfs_printk(KERN_ERR
, "Error creating new file "
192 "context; rc = [%d]\n", rc
);
195 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
196 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
198 printk(KERN_ERR
"%s: Error attempting to initialize "
199 "the persistent file for the dentry with name "
200 "[%s]; rc = [%d]\n", __func__
,
201 ecryptfs_dentry
->d_name
.name
, rc
);
205 rc
= ecryptfs_write_metadata(ecryptfs_dentry
);
207 printk(KERN_ERR
"Error writing headers; rc = [%d]\n", rc
);
210 rc
= grow_file(ecryptfs_dentry
);
212 printk(KERN_ERR
"Error growing file; rc = [%d]\n", rc
);
219 * @dir: The inode of the directory in which to create the file.
220 * @dentry: The eCryptfs dentry
221 * @mode: The mode of the new file.
224 * Creates a new file.
226 * Returns zero on success; non-zero on error condition
229 ecryptfs_create(struct inode
*directory_inode
, struct dentry
*ecryptfs_dentry
,
230 int mode
, struct nameidata
*nd
)
234 /* ecryptfs_do_create() calls ecryptfs_interpose() */
235 rc
= ecryptfs_do_create(directory_inode
, ecryptfs_dentry
, mode
, nd
);
237 ecryptfs_printk(KERN_WARNING
, "Failed to create file in"
238 "lower filesystem\n");
241 /* At this point, a file exists on "disk"; we need to make sure
242 * that this on disk file is prepared to be an ecryptfs file */
243 rc
= ecryptfs_initialize_file(ecryptfs_dentry
);
249 * ecryptfs_lookup_and_interpose_lower - Perform a lookup
251 int ecryptfs_lookup_and_interpose_lower(struct dentry
*ecryptfs_dentry
,
252 struct dentry
*lower_dentry
,
253 struct inode
*ecryptfs_dir_inode
,
254 struct nameidata
*ecryptfs_nd
)
256 struct dentry
*lower_dir_dentry
;
257 struct vfsmount
*lower_mnt
;
258 struct inode
*lower_inode
;
259 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
260 struct ecryptfs_crypt_stat
*crypt_stat
;
261 char *page_virt
= NULL
;
265 lower_dir_dentry
= lower_dentry
->d_parent
;
266 lower_mnt
= mntget(ecryptfs_dentry_to_lower_mnt(
267 ecryptfs_dentry
->d_parent
));
268 lower_inode
= lower_dentry
->d_inode
;
269 fsstack_copy_attr_atime(ecryptfs_dir_inode
, lower_dir_dentry
->d_inode
);
270 BUG_ON(!atomic_read(&lower_dentry
->d_count
));
271 ecryptfs_set_dentry_private(ecryptfs_dentry
,
272 kmem_cache_alloc(ecryptfs_dentry_info_cache
,
274 if (!ecryptfs_dentry_to_private(ecryptfs_dentry
)) {
276 printk(KERN_ERR
"%s: Out of memory whilst attempting "
277 "to allocate ecryptfs_dentry_info struct\n",
281 ecryptfs_set_dentry_lower(ecryptfs_dentry
, lower_dentry
);
282 ecryptfs_set_dentry_lower_mnt(ecryptfs_dentry
, lower_mnt
);
283 if (!lower_dentry
->d_inode
) {
284 /* We want to add because we couldn't find in lower */
285 d_add(ecryptfs_dentry
, NULL
);
288 rc
= ecryptfs_interpose(lower_dentry
, ecryptfs_dentry
,
289 ecryptfs_dir_inode
->i_sb
,
290 ECRYPTFS_INTERPOSE_FLAG_D_ADD
);
292 printk(KERN_ERR
"%s: Error interposing; rc = [%d]\n",
296 if (S_ISDIR(lower_inode
->i_mode
))
298 if (S_ISLNK(lower_inode
->i_mode
))
300 if (special_file(lower_inode
->i_mode
))
304 /* Released in this function */
305 page_virt
= kmem_cache_zalloc(ecryptfs_header_cache_2
, GFP_USER
);
307 printk(KERN_ERR
"%s: Cannot kmem_cache_zalloc() a page\n",
312 if (!ecryptfs_inode_to_private(ecryptfs_dentry
->d_inode
)->lower_file
) {
313 rc
= ecryptfs_init_persistent_file(ecryptfs_dentry
);
315 printk(KERN_ERR
"%s: Error attempting to initialize "
316 "the persistent file for the dentry with name "
317 "[%s]; rc = [%d]\n", __func__
,
318 ecryptfs_dentry
->d_name
.name
, rc
);
322 crypt_stat
= &ecryptfs_inode_to_private(
323 ecryptfs_dentry
->d_inode
)->crypt_stat
;
324 /* TODO: lock for crypt_stat comparison */
325 if (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
))
326 ecryptfs_set_default_sizes(crypt_stat
);
327 rc
= ecryptfs_read_and_validate_header_region(page_virt
,
328 ecryptfs_dentry
->d_inode
);
330 rc
= ecryptfs_read_and_validate_xattr_region(page_virt
,
336 crypt_stat
->flags
|= ECRYPTFS_METADATA_IN_XATTR
;
338 mount_crypt_stat
= &ecryptfs_superblock_to_private(
339 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
340 if (mount_crypt_stat
->flags
& ECRYPTFS_ENCRYPTED_VIEW_ENABLED
) {
341 if (crypt_stat
->flags
& ECRYPTFS_METADATA_IN_XATTR
)
342 file_size
= (crypt_stat
->num_header_bytes_at_front
343 + i_size_read(lower_dentry
->d_inode
));
345 file_size
= i_size_read(lower_dentry
->d_inode
);
347 file_size
= get_unaligned_be64(page_virt
);
349 i_size_write(ecryptfs_dentry
->d_inode
, (loff_t
)file_size
);
351 kmem_cache_free(ecryptfs_header_cache_2
, page_virt
);
355 d_drop(ecryptfs_dentry
);
362 * @ecryptfs_dir_inode: The eCryptfs directory inode
363 * @ecryptfs_dentry: The eCryptfs dentry that we are looking up
364 * @ecryptfs_nd: nameidata; may be NULL
366 * Find a file on disk. If the file does not exist, then we'll add it to the
367 * dentry cache and continue on to read it from the disk.
369 static struct dentry
*ecryptfs_lookup(struct inode
*ecryptfs_dir_inode
,
370 struct dentry
*ecryptfs_dentry
,
371 struct nameidata
*ecryptfs_nd
)
373 char *encrypted_and_encoded_name
= NULL
;
374 size_t encrypted_and_encoded_name_size
;
375 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
376 struct dentry
*lower_dir_dentry
, *lower_dentry
;
379 ecryptfs_dentry
->d_op
= &ecryptfs_dops
;
380 if ((ecryptfs_dentry
->d_name
.len
== 1
381 && !strcmp(ecryptfs_dentry
->d_name
.name
, "."))
382 || (ecryptfs_dentry
->d_name
.len
== 2
383 && !strcmp(ecryptfs_dentry
->d_name
.name
, ".."))) {
386 lower_dir_dentry
= ecryptfs_dentry_to_lower(ecryptfs_dentry
->d_parent
);
387 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
388 lower_dentry
= lookup_one_len(ecryptfs_dentry
->d_name
.name
,
390 ecryptfs_dentry
->d_name
.len
);
391 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
392 if (IS_ERR(lower_dentry
)) {
393 rc
= PTR_ERR(lower_dentry
);
394 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
395 "lower_dentry = [%s]\n", __func__
, rc
,
396 ecryptfs_dentry
->d_name
.name
);
399 if (lower_dentry
->d_inode
)
400 goto lookup_and_interpose
;
401 mount_crypt_stat
= &ecryptfs_superblock_to_private(
402 ecryptfs_dentry
->d_sb
)->mount_crypt_stat
;
403 if (!(mount_crypt_stat
404 && (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
)))
405 goto lookup_and_interpose
;
407 rc
= ecryptfs_encrypt_and_encode_filename(
408 &encrypted_and_encoded_name
, &encrypted_and_encoded_name_size
,
409 NULL
, mount_crypt_stat
, ecryptfs_dentry
->d_name
.name
,
410 ecryptfs_dentry
->d_name
.len
);
412 printk(KERN_ERR
"%s: Error attempting to encrypt and encode "
413 "filename; rc = [%d]\n", __func__
, rc
);
416 mutex_lock(&lower_dir_dentry
->d_inode
->i_mutex
);
417 lower_dentry
= lookup_one_len(encrypted_and_encoded_name
,
419 encrypted_and_encoded_name_size
- 1);
420 mutex_unlock(&lower_dir_dentry
->d_inode
->i_mutex
);
421 if (IS_ERR(lower_dentry
)) {
422 rc
= PTR_ERR(lower_dentry
);
423 printk(KERN_ERR
"%s: lookup_one_len() returned [%d] on "
424 "lower_dentry = [%s]\n", __func__
, rc
,
425 encrypted_and_encoded_name
);
428 lookup_and_interpose
:
429 rc
= ecryptfs_lookup_and_interpose_lower(ecryptfs_dentry
, lower_dentry
,
434 d_drop(ecryptfs_dentry
);
436 kfree(encrypted_and_encoded_name
);
440 static int ecryptfs_link(struct dentry
*old_dentry
, struct inode
*dir
,
441 struct dentry
*new_dentry
)
443 struct dentry
*lower_old_dentry
;
444 struct dentry
*lower_new_dentry
;
445 struct dentry
*lower_dir_dentry
;
449 file_size_save
= i_size_read(old_dentry
->d_inode
);
450 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
451 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
452 dget(lower_old_dentry
);
453 dget(lower_new_dentry
);
454 lower_dir_dentry
= lock_parent(lower_new_dentry
);
455 rc
= vfs_link(lower_old_dentry
, lower_dir_dentry
->d_inode
,
457 if (rc
|| !lower_new_dentry
->d_inode
)
459 rc
= ecryptfs_interpose(lower_new_dentry
, new_dentry
, dir
->i_sb
, 0);
462 fsstack_copy_attr_times(dir
, lower_new_dentry
->d_inode
);
463 fsstack_copy_inode_size(dir
, lower_new_dentry
->d_inode
);
464 old_dentry
->d_inode
->i_nlink
=
465 ecryptfs_inode_to_lower(old_dentry
->d_inode
)->i_nlink
;
466 i_size_write(new_dentry
->d_inode
, file_size_save
);
468 unlock_dir(lower_dir_dentry
);
469 dput(lower_new_dentry
);
470 dput(lower_old_dentry
);
474 static int ecryptfs_unlink(struct inode
*dir
, struct dentry
*dentry
)
477 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
478 struct inode
*lower_dir_inode
= ecryptfs_inode_to_lower(dir
);
479 struct dentry
*lower_dir_dentry
;
482 lower_dir_dentry
= lock_parent(lower_dentry
);
483 rc
= vfs_unlink(lower_dir_inode
, lower_dentry
);
485 printk(KERN_ERR
"Error in vfs_unlink; rc = [%d]\n", rc
);
488 fsstack_copy_attr_times(dir
, lower_dir_inode
);
489 dentry
->d_inode
->i_nlink
=
490 ecryptfs_inode_to_lower(dentry
->d_inode
)->i_nlink
;
491 dentry
->d_inode
->i_ctime
= dir
->i_ctime
;
494 unlock_dir(lower_dir_dentry
);
499 static int ecryptfs_symlink(struct inode
*dir
, struct dentry
*dentry
,
503 struct dentry
*lower_dentry
;
504 struct dentry
*lower_dir_dentry
;
505 char *encoded_symname
;
506 size_t encoded_symlen
;
507 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
= NULL
;
509 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
511 lower_dir_dentry
= lock_parent(lower_dentry
);
512 mount_crypt_stat
= &ecryptfs_superblock_to_private(
513 dir
->i_sb
)->mount_crypt_stat
;
514 rc
= ecryptfs_encrypt_and_encode_filename(&encoded_symname
,
517 mount_crypt_stat
, symname
,
521 rc
= vfs_symlink(lower_dir_dentry
->d_inode
, lower_dentry
,
523 kfree(encoded_symname
);
524 if (rc
|| !lower_dentry
->d_inode
)
526 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
529 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
530 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
532 unlock_dir(lower_dir_dentry
);
534 if (!dentry
->d_inode
)
539 static int ecryptfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
)
542 struct dentry
*lower_dentry
;
543 struct dentry
*lower_dir_dentry
;
545 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
546 lower_dir_dentry
= lock_parent(lower_dentry
);
547 rc
= vfs_mkdir(lower_dir_dentry
->d_inode
, lower_dentry
, mode
);
548 if (rc
|| !lower_dentry
->d_inode
)
550 rc
= ecryptfs_interpose(lower_dentry
, dentry
, dir
->i_sb
, 0);
553 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
554 fsstack_copy_inode_size(dir
, lower_dir_dentry
->d_inode
);
555 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
557 unlock_dir(lower_dir_dentry
);
558 if (!dentry
->d_inode
)
563 static int ecryptfs_rmdir(struct inode
*dir
, struct dentry
*dentry
)
565 struct dentry
*lower_dentry
;
566 struct dentry
*lower_dir_dentry
;
569 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
571 lower_dir_dentry
= lock_parent(lower_dentry
);
573 rc
= vfs_rmdir(lower_dir_dentry
->d_inode
, lower_dentry
);
576 d_delete(lower_dentry
);
577 fsstack_copy_attr_times(dir
, lower_dir_dentry
->d_inode
);
578 dir
->i_nlink
= lower_dir_dentry
->d_inode
->i_nlink
;
579 unlock_dir(lower_dir_dentry
);
587 ecryptfs_mknod(struct inode
*dir
, struct dentry
*dentry
, int mode
, dev_t dev
)
590 struct dentry
*lower_dentry
;
591 struct dentry
*lower_dir_dentry
;
593 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
594 lower_dir_dentry
= lock_parent(lower_dentry
);
595 rc
= vfs_mknod(lower_dir_dentry
->d_inode
, lower_dentry
, mode
, dev
);
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
);
605 if (!dentry
->d_inode
)
611 ecryptfs_rename(struct inode
*old_dir
, struct dentry
*old_dentry
,
612 struct inode
*new_dir
, struct dentry
*new_dentry
)
615 struct dentry
*lower_old_dentry
;
616 struct dentry
*lower_new_dentry
;
617 struct dentry
*lower_old_dir_dentry
;
618 struct dentry
*lower_new_dir_dentry
;
619 struct dentry
*trap
= NULL
;
621 lower_old_dentry
= ecryptfs_dentry_to_lower(old_dentry
);
622 lower_new_dentry
= ecryptfs_dentry_to_lower(new_dentry
);
623 dget(lower_old_dentry
);
624 dget(lower_new_dentry
);
625 lower_old_dir_dentry
= dget_parent(lower_old_dentry
);
626 lower_new_dir_dentry
= dget_parent(lower_new_dentry
);
627 trap
= lock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
628 /* source should not be ancestor of target */
629 if (trap
== lower_old_dentry
) {
633 /* target should not be ancestor of source */
634 if (trap
== lower_new_dentry
) {
638 rc
= vfs_rename(lower_old_dir_dentry
->d_inode
, lower_old_dentry
,
639 lower_new_dir_dentry
->d_inode
, lower_new_dentry
);
642 fsstack_copy_attr_all(new_dir
, lower_new_dir_dentry
->d_inode
);
643 if (new_dir
!= old_dir
)
644 fsstack_copy_attr_all(old_dir
, lower_old_dir_dentry
->d_inode
);
646 unlock_rename(lower_old_dir_dentry
, lower_new_dir_dentry
);
647 dput(lower_new_dentry
->d_parent
);
648 dput(lower_old_dentry
->d_parent
);
649 dput(lower_new_dentry
);
650 dput(lower_old_dentry
);
654 static int ecryptfs_readlink_lower(struct dentry
*dentry
, char **buf
,
657 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
659 size_t lower_bufsiz
= PATH_MAX
;
663 lower_buf
= kmalloc(lower_bufsiz
, GFP_KERNEL
);
670 rc
= lower_dentry
->d_inode
->i_op
->readlink(lower_dentry
,
671 (char __user
*)lower_buf
,
677 rc
= ecryptfs_decode_and_decrypt_filename(buf
, bufsiz
, dentry
,
678 lower_buf
, lower_bufsiz
);
685 ecryptfs_readlink(struct dentry
*dentry
, char __user
*buf
, int bufsiz
)
688 size_t kbufsiz
, copied
;
691 rc
= ecryptfs_readlink_lower(dentry
, &kbuf
, &kbufsiz
);
694 copied
= min_t(size_t, bufsiz
, kbufsiz
);
695 rc
= copy_to_user(buf
, kbuf
, copied
) ? -EFAULT
: copied
;
697 fsstack_copy_attr_atime(dentry
->d_inode
,
698 ecryptfs_dentry_to_lower(dentry
)->d_inode
);
703 static void *ecryptfs_follow_link(struct dentry
*dentry
, struct nameidata
*nd
)
706 int len
= PAGE_SIZE
, rc
;
709 /* Released in ecryptfs_put_link(); only release here on error */
710 buf
= kmalloc(len
, GFP_KERNEL
);
712 buf
= ERR_PTR(-ENOMEM
);
717 rc
= dentry
->d_inode
->i_op
->readlink(dentry
, (char __user
*)buf
, len
);
725 nd_set_link(nd
, buf
);
730 ecryptfs_put_link(struct dentry
*dentry
, struct nameidata
*nd
, void *ptr
)
732 char *buf
= nd_get_link(nd
);
740 * upper_size_to_lower_size
741 * @crypt_stat: Crypt_stat associated with file
742 * @upper_size: Size of the upper file
744 * Calculate the required size of the lower file based on the
745 * specified size of the upper file. This calculation is based on the
746 * number of headers in the underlying file and the extent size.
748 * Returns Calculated size of the lower file.
751 upper_size_to_lower_size(struct ecryptfs_crypt_stat
*crypt_stat
,
756 lower_size
= crypt_stat
->num_header_bytes_at_front
;
757 if (upper_size
!= 0) {
760 num_extents
= upper_size
>> crypt_stat
->extent_shift
;
761 if (upper_size
& ~crypt_stat
->extent_mask
)
763 lower_size
+= (num_extents
* crypt_stat
->extent_size
);
770 * @dentry: The ecryptfs layer dentry
771 * @ia: Address of the ecryptfs inode's attributes
772 * @lower_ia: Address of the lower inode's attributes
774 * Function to handle truncations modifying the size of the file. Note
775 * that the file sizes are interpolated. When expanding, we are simply
776 * writing strings of 0's out. When truncating, we truncate the upper
777 * inode and update the lower_ia according to the page index
778 * interpolations. If ATTR_SIZE is set in lower_ia->ia_valid upon return,
779 * the caller must use lower_ia in a call to notify_change() to perform
780 * the truncation of the lower inode.
782 * Returns zero on success; non-zero otherwise
784 static int truncate_upper(struct dentry
*dentry
, struct iattr
*ia
,
785 struct iattr
*lower_ia
)
788 struct inode
*inode
= dentry
->d_inode
;
789 struct dentry
*lower_dentry
;
790 struct file fake_ecryptfs_file
;
791 struct ecryptfs_crypt_stat
*crypt_stat
;
792 loff_t i_size
= i_size_read(inode
);
793 loff_t lower_size_before_truncate
;
794 loff_t lower_size_after_truncate
;
796 if (unlikely((ia
->ia_size
== i_size
))) {
797 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
800 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
801 /* Set up a fake ecryptfs file, this is used to interface with
802 * the file in the underlying filesystem so that the
803 * truncation has an effect there as well. */
804 memset(&fake_ecryptfs_file
, 0, sizeof(fake_ecryptfs_file
));
805 fake_ecryptfs_file
.f_path
.dentry
= dentry
;
806 /* Released at out_free: label */
807 ecryptfs_set_file_private(&fake_ecryptfs_file
,
808 kmem_cache_alloc(ecryptfs_file_info_cache
,
810 if (unlikely(!ecryptfs_file_to_private(&fake_ecryptfs_file
))) {
814 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
815 ecryptfs_set_file_lower(
817 ecryptfs_inode_to_private(dentry
->d_inode
)->lower_file
);
818 /* Switch on growing or shrinking file */
819 if (ia
->ia_size
> i_size
) {
820 char zero
[] = { 0x00 };
822 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
823 /* Write a single 0 at the last position of the file;
824 * this triggers code that will fill in 0's throughout
825 * the intermediate portion of the previous end of the
826 * file and the new and of the file */
827 rc
= ecryptfs_write(&fake_ecryptfs_file
, zero
,
828 (ia
->ia_size
- 1), 1);
829 } else { /* ia->ia_size < i_size_read(inode) */
830 /* We're chopping off all the pages down to the page
831 * in which ia->ia_size is located. Fill in the end of
832 * that page from (ia->ia_size & ~PAGE_CACHE_MASK) to
833 * PAGE_CACHE_SIZE with zeros. */
834 size_t num_zeros
= (PAGE_CACHE_SIZE
835 - (ia
->ia_size
& ~PAGE_CACHE_MASK
));
837 if (!(crypt_stat
->flags
& ECRYPTFS_ENCRYPTED
)) {
838 rc
= vmtruncate(inode
, ia
->ia_size
);
841 lower_ia
->ia_size
= ia
->ia_size
;
842 lower_ia
->ia_valid
|= ATTR_SIZE
;
848 zeros_virt
= kzalloc(num_zeros
, GFP_KERNEL
);
853 rc
= ecryptfs_write(&fake_ecryptfs_file
, zeros_virt
,
854 ia
->ia_size
, num_zeros
);
857 printk(KERN_ERR
"Error attempting to zero out "
858 "the remainder of the end page on "
859 "reducing truncate; rc = [%d]\n", rc
);
863 vmtruncate(inode
, ia
->ia_size
);
864 rc
= ecryptfs_write_inode_size_to_metadata(inode
);
866 printk(KERN_ERR
"Problem with "
867 "ecryptfs_write_inode_size_to_metadata; "
871 /* We are reducing the size of the ecryptfs file, and need to
872 * know if we need to reduce the size of the lower file. */
873 lower_size_before_truncate
=
874 upper_size_to_lower_size(crypt_stat
, i_size
);
875 lower_size_after_truncate
=
876 upper_size_to_lower_size(crypt_stat
, ia
->ia_size
);
877 if (lower_size_after_truncate
< lower_size_before_truncate
) {
878 lower_ia
->ia_size
= lower_size_after_truncate
;
879 lower_ia
->ia_valid
|= ATTR_SIZE
;
881 lower_ia
->ia_valid
&= ~ATTR_SIZE
;
884 if (ecryptfs_file_to_private(&fake_ecryptfs_file
))
885 kmem_cache_free(ecryptfs_file_info_cache
,
886 ecryptfs_file_to_private(&fake_ecryptfs_file
));
893 * @dentry: The ecryptfs layer dentry
894 * @new_length: The length to expand the file to
896 * Simple function that handles the truncation of an eCryptfs inode and
897 * its corresponding lower inode.
899 * Returns zero on success; non-zero otherwise
901 int ecryptfs_truncate(struct dentry
*dentry
, loff_t new_length
)
903 struct iattr ia
= { .ia_valid
= ATTR_SIZE
, .ia_size
= new_length
};
904 struct iattr lower_ia
= { .ia_valid
= 0 };
907 rc
= truncate_upper(dentry
, &ia
, &lower_ia
);
908 if (!rc
&& lower_ia
.ia_valid
& ATTR_SIZE
) {
909 struct dentry
*lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
911 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
912 rc
= notify_change(lower_dentry
, &lower_ia
);
913 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
919 ecryptfs_permission(struct inode
*inode
, int mask
)
921 return inode_permission(ecryptfs_inode_to_lower(inode
), mask
);
926 * @dentry: dentry handle to the inode to modify
927 * @ia: Structure with flags of what to change and values
929 * Updates the metadata of an inode. If the update is to the size
930 * i.e. truncation, then ecryptfs_truncate will handle the size modification
931 * of both the ecryptfs inode and the lower inode.
933 * All other metadata changes will be passed right to the lower filesystem,
934 * and we will just update our inode to look like the lower.
936 static int ecryptfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
939 struct dentry
*lower_dentry
;
940 struct iattr lower_ia
;
942 struct inode
*lower_inode
;
943 struct ecryptfs_crypt_stat
*crypt_stat
;
945 crypt_stat
= &ecryptfs_inode_to_private(dentry
->d_inode
)->crypt_stat
;
946 if (!(crypt_stat
->flags
& ECRYPTFS_STRUCT_INITIALIZED
))
947 ecryptfs_init_crypt_stat(crypt_stat
);
948 inode
= dentry
->d_inode
;
949 lower_inode
= ecryptfs_inode_to_lower(inode
);
950 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
951 mutex_lock(&crypt_stat
->cs_mutex
);
952 if (S_ISDIR(dentry
->d_inode
->i_mode
))
953 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
954 else if (S_ISREG(dentry
->d_inode
->i_mode
)
955 && (!(crypt_stat
->flags
& ECRYPTFS_POLICY_APPLIED
)
956 || !(crypt_stat
->flags
& ECRYPTFS_KEY_VALID
))) {
957 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
959 mount_crypt_stat
= &ecryptfs_superblock_to_private(
960 dentry
->d_sb
)->mount_crypt_stat
;
961 rc
= ecryptfs_read_metadata(dentry
);
963 if (!(mount_crypt_stat
->flags
964 & ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED
)) {
966 printk(KERN_WARNING
"Either the lower file "
967 "is not in a valid eCryptfs format, "
968 "or the key could not be retrieved. "
969 "Plaintext passthrough mode is not "
970 "enabled; returning -EIO\n");
971 mutex_unlock(&crypt_stat
->cs_mutex
);
975 crypt_stat
->flags
&= ~(ECRYPTFS_ENCRYPTED
);
978 mutex_unlock(&crypt_stat
->cs_mutex
);
979 memcpy(&lower_ia
, ia
, sizeof(lower_ia
));
980 if (ia
->ia_valid
& ATTR_FILE
)
981 lower_ia
.ia_file
= ecryptfs_file_to_lower(ia
->ia_file
);
982 if (ia
->ia_valid
& ATTR_SIZE
) {
983 rc
= truncate_upper(dentry
, ia
, &lower_ia
);
989 * mode change is for clearing setuid/setgid bits. Allow lower fs
990 * to interpret this in its own way.
992 if (lower_ia
.ia_valid
& (ATTR_KILL_SUID
| ATTR_KILL_SGID
))
993 lower_ia
.ia_valid
&= ~ATTR_MODE
;
995 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
996 rc
= notify_change(lower_dentry
, &lower_ia
);
997 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
999 fsstack_copy_attr_all(inode
, lower_inode
);
1003 int ecryptfs_getattr_link(struct vfsmount
*mnt
, struct dentry
*dentry
,
1006 struct ecryptfs_mount_crypt_stat
*mount_crypt_stat
;
1009 mount_crypt_stat
= &ecryptfs_superblock_to_private(
1010 dentry
->d_sb
)->mount_crypt_stat
;
1011 generic_fillattr(dentry
->d_inode
, stat
);
1012 if (mount_crypt_stat
->flags
& ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES
) {
1016 rc
= ecryptfs_readlink_lower(dentry
, &target
, &targetsiz
);
1019 stat
->size
= targetsiz
;
1025 int ecryptfs_getattr(struct vfsmount
*mnt
, struct dentry
*dentry
,
1028 struct kstat lower_stat
;
1031 rc
= vfs_getattr(ecryptfs_dentry_to_lower_mnt(dentry
),
1032 ecryptfs_dentry_to_lower(dentry
), &lower_stat
);
1034 generic_fillattr(dentry
->d_inode
, stat
);
1035 stat
->blocks
= lower_stat
.blocks
;
1041 ecryptfs_setxattr(struct dentry
*dentry
, const char *name
, const void *value
,
1042 size_t size
, int flags
)
1045 struct dentry
*lower_dentry
;
1047 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1048 if (!lower_dentry
->d_inode
->i_op
->setxattr
) {
1052 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1053 rc
= lower_dentry
->d_inode
->i_op
->setxattr(lower_dentry
, name
, value
,
1055 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1061 ecryptfs_getxattr_lower(struct dentry
*lower_dentry
, const char *name
,
1062 void *value
, size_t size
)
1066 if (!lower_dentry
->d_inode
->i_op
->getxattr
) {
1070 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1071 rc
= lower_dentry
->d_inode
->i_op
->getxattr(lower_dentry
, name
, value
,
1073 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1079 ecryptfs_getxattr(struct dentry
*dentry
, const char *name
, void *value
,
1082 return ecryptfs_getxattr_lower(ecryptfs_dentry_to_lower(dentry
), name
,
1087 ecryptfs_listxattr(struct dentry
*dentry
, char *list
, size_t size
)
1090 struct dentry
*lower_dentry
;
1092 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1093 if (!lower_dentry
->d_inode
->i_op
->listxattr
) {
1097 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1098 rc
= lower_dentry
->d_inode
->i_op
->listxattr(lower_dentry
, list
, size
);
1099 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1104 static int ecryptfs_removexattr(struct dentry
*dentry
, const char *name
)
1107 struct dentry
*lower_dentry
;
1109 lower_dentry
= ecryptfs_dentry_to_lower(dentry
);
1110 if (!lower_dentry
->d_inode
->i_op
->removexattr
) {
1114 mutex_lock(&lower_dentry
->d_inode
->i_mutex
);
1115 rc
= lower_dentry
->d_inode
->i_op
->removexattr(lower_dentry
, name
);
1116 mutex_unlock(&lower_dentry
->d_inode
->i_mutex
);
1121 int ecryptfs_inode_test(struct inode
*inode
, void *candidate_lower_inode
)
1123 if ((ecryptfs_inode_to_lower(inode
)
1124 == (struct inode
*)candidate_lower_inode
))
1130 int ecryptfs_inode_set(struct inode
*inode
, void *lower_inode
)
1132 ecryptfs_init_inode(inode
, (struct inode
*)lower_inode
);
1136 const struct inode_operations ecryptfs_symlink_iops
= {
1137 .readlink
= ecryptfs_readlink
,
1138 .follow_link
= ecryptfs_follow_link
,
1139 .put_link
= ecryptfs_put_link
,
1140 .permission
= ecryptfs_permission
,
1141 .setattr
= ecryptfs_setattr
,
1142 .getattr
= ecryptfs_getattr_link
,
1143 .setxattr
= ecryptfs_setxattr
,
1144 .getxattr
= ecryptfs_getxattr
,
1145 .listxattr
= ecryptfs_listxattr
,
1146 .removexattr
= ecryptfs_removexattr
1149 const struct inode_operations ecryptfs_dir_iops
= {
1150 .create
= ecryptfs_create
,
1151 .lookup
= ecryptfs_lookup
,
1152 .link
= ecryptfs_link
,
1153 .unlink
= ecryptfs_unlink
,
1154 .symlink
= ecryptfs_symlink
,
1155 .mkdir
= ecryptfs_mkdir
,
1156 .rmdir
= ecryptfs_rmdir
,
1157 .mknod
= ecryptfs_mknod
,
1158 .rename
= ecryptfs_rename
,
1159 .permission
= ecryptfs_permission
,
1160 .setattr
= ecryptfs_setattr
,
1161 .setxattr
= ecryptfs_setxattr
,
1162 .getxattr
= ecryptfs_getxattr
,
1163 .listxattr
= ecryptfs_listxattr
,
1164 .removexattr
= ecryptfs_removexattr
1167 const struct inode_operations ecryptfs_main_iops
= {
1168 .permission
= ecryptfs_permission
,
1169 .setattr
= ecryptfs_setattr
,
1170 .getattr
= ecryptfs_getattr
,
1171 .setxattr
= ecryptfs_setxattr
,
1172 .getxattr
= ecryptfs_getxattr
,
1173 .listxattr
= ecryptfs_listxattr
,
1174 .removexattr
= ecryptfs_removexattr